Skip to content

Commit 2805232

Browse files
committed
[i18n] Introduce notranslate convention and guidance
1 parent 0369108 commit 2805232

File tree

2 files changed

+19
-17
lines changed

2 files changed

+19
-17
lines changed

content/en/docs/contributing/localization.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ guidance offered in this section.
2525
- **Translate**:
2626
- Page content, including:
2727
- Mermaid [diagram](#images) text fields
28-
- Code comments from code excerpts
28+
- Code comments from code excerpts (optional)
2929
- [Front matter][] field values for `title`, `linkTitle`, and `description`
3030
- **All** page content and front matter unless indicated otherwise
3131
- **Preserve** the _content_, _meaning_, and _style_ of the original text
@@ -45,6 +45,9 @@ guidance offered in this section.
4545
- **Translate**:
4646
- **File or directory** names of resources in this repository
4747
- [Links](#links), this includes [heading IDs](#headings).[^*]
48+
- Inline code-spans like these: `inline code example`
49+
- Markdown elements marked as `notranslate` (usually as a CSS class), in
50+
particular for [headings](#headings)
4851
- [Front matter][] fields other than those listed in [Do](#do). In particular,
4952
do not translate `aliases`. When in doubt, ask maintainers.
5053
- Code

content/en/docs/contributing/pr-checks.md

+15-16
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
title: Pull request checks
33
description: Learn how to make your pull request successfully pass all checks
44
weight: 40
5-
cSpell:ignore: REFCACHE
65
---
76

87
When you raise a
@@ -31,7 +30,7 @@ can recover from a failed state.
3130

3231
{{% /alert %}}
3332

34-
## Easy CLA
33+
## `Easy CLA` {.notranslate lang=en}
3534

3635
This check fails if you haven't [signed the CLA](../prerequisites/#cla).
3736

@@ -49,7 +48,7 @@ find any issues.
4948
The following list describes current checks and what you can do to fix related
5049
errors:
5150

52-
### TEXT linter
51+
### `TEXT linter` {.notranslate lang=en}
5352

5453
This check verifies that
5554
[OpenTelemetry-specific terms and words are used consistently across the site](../style-guide/#opentelemetryio-word-list).
@@ -59,51 +58,51 @@ If any issues are found, annotations are added to your files in the
5958
alternative, you can run `npm run check:text -- --fix` locally to fix most
6059
issues. Run `npm run check:text` again and manually fix the remaining issues.
6160

62-
### MARKDOWN linter
61+
### `MARKDOWN linter` {.notranslate lang=en}
6362

6463
This check verifies that
6564
[standards and consistency for Markdown files are enforced](../style-guide/#markdown-standards).
6665

6766
If any issues are found, run `npm run:format` to fix most issues. For more
6867
complex issues, run `npm run check:markdown` and apply the suggested changes.
6968

70-
### SPELLING check
69+
### `SPELLING check` {.notranslate lang=en}
7170

7271
This check verifies that
7372
[all words are spelled correctly](../style-guide/#spell-checking).
7473

75-
### CSPELL:IGNORE check
74+
### `CSPELL` check {.notranslate lang=en}
7675

7776
This check will verify that all words in your cSpell ignore list are normalized.
7877

7978
If this check fails, run `npm run fix:dict` locally and push the changes in a
8079
new commit.
8180

82-
### FILENAME check
81+
### `FILENAME check` {.notranslate lang=en}
8382

8483
This check verifies that all
8584
[files are formatted by prettier](../style-guide/#file-format).
8685

8786
If this check fails, run `npm fix:format` locally and push the changes in a new
8887
commit.
8988

90-
### FILE FORMAT
89+
### `FILE FORMAT` {.notranslate lang=en}
9190

9291
This check verifies that all
9392
[file names are in kebab-case](../style-guide/#file-names).
9493

9594
If this check fails, run `npm fix:filenames` locally and push the changes in a
9695
new commit.
9796

98-
### BUILD and CHECK LINKS / REFCACHE updates?
97+
### `BUILD and CHECK LINKS` {.notranslate lang=en}
9998

100-
This check verifies that all links that your commits are introducing are
101-
functional.
99+
This check builds the website and verifies that all links are valid.
102100

103-
Run `npm run check:links` to check them locally. This also updates the reference
104-
cache, or `REFCACHE`. Push any changes to the `REFCACHE` in a new commit.
101+
To check links locally, run `npm run check:links`. This command also updates the
102+
reference cache. Push any changes to the refcache in a new commit.
105103

106-
### WARNINGS in build log?
104+
### `WARNINGS in build log?` {.notranslate lang=en}
107105

108-
If this check fails, review the build log for any other potential issues. Ask
109-
maintainers for help, if you are unsure how to recover.
106+
If this check fails, review the `BUILD and CHECK LINKS` log, under the
107+
`npm run log:check:links` step, for any other potential issues. Ask maintainers
108+
for help, if you are unsure how to recover.

0 commit comments

Comments
 (0)