@@ -16,24 +16,48 @@ as can be seen from the languages dropdown menu in the top nav.
16
16
When translating website pages from English, we recommend that you follow the
17
17
guidance offered in this section.
18
18
19
- ### Summary / TL;DR {#summary}
19
+ ### Summary
20
20
21
- Do translate:
21
+ #### ✅ Do {#do}
22
22
23
- - [ Front matter] [ ] fields ` title ` , ` linkTitle ` , and ` description `
24
- - Page content, including the text fields in Mermaid [ diagrams] ( #images )
23
+ <div class =" border-start border-success bg-success-subtle " >
25
24
26
- Do ** NOT** :
25
+ - ** Translate** :
26
+ - Page content, including:
27
+ - Mermaid [ diagram] ( #images ) text fields
28
+ - Code comments from code excerpts
29
+ - [ Front matter] [ ] field values for ` title ` , ` linkTitle ` , and ` description `
30
+ - ** All** page content and front matter unless indicated otherwise
31
+ - ** Preserve** the _ content_ , _ meaning_ , and _ style_ of the original text
32
+ - ** Ask** [ maintainers] if you have any doubts or questions through:
33
+ - [ Slack] ` #otel-docs-localization ` or ` #otel-comms ` channels
34
+ - [ Discussion] , issue, or PR comment
27
35
28
- - Translate:
36
+ [ Discussion] :
37
+ https://github.com/open-telemetry/opentelemetry.io/discussions?discussions_q=is%3Aopen+label%3Ai18n
38
+
39
+ </div >
40
+
41
+ #### ❌ Do NOT {#do-not}
42
+
43
+ <div class =" border-start border-warning bg-warning-subtle " >
44
+
45
+ - ** Translate** :
29
46
- ** File or directory** names of resources in this repository
30
47
- [ Links] ( #links ) , this includes [ heading IDs] ( #headings ) .[ ^ * ]
31
- - [ Front matter] [ ] fields other than those listed in the "Do" section above.
32
- In particular, do not translate ` aliases ` . When in doubt, ask maintainers.
48
+ - [ Front matter] [ ] fields other than those listed in [ Do] ( #do ) . In particular,
49
+ do not translate ` aliases ` . When in doubt, ask maintainers.
50
+ - Code
33
51
- Create ** copies of images** , unless you [ localize text in the images] ( #images )
52
+ - Add new or change:
53
+ - ** Content** that would be different from the originally intended meaning
54
+ - Presentation ** style** , including: _ formatting_ , _ layout_ , and _ design_
55
+ style (typography, letter case, and spacing for example).
34
56
35
57
[ ^ * ] : For a possible exception, see [ Links] ( #links ) .
36
58
59
+ </div >
60
+
37
61
### Heading IDs {#headings}
38
62
39
63
To ensure that heading anchor targets are uniform across localizations, when
@@ -321,5 +345,7 @@ non-English pages. When this happens:
321
345
322
346
[front matter] : https://gohugo.io/content-management/front-matter/
323
347
[main] : https://github.com/open-telemetry/opentelemetry.io/commits/main/
348
+ [maintainers] : https://github.com/orgs/open-telemetry/teams/docs-maintainers
324
349
[multilingual framework] : https://gohugo.io/content-management/multilingual/
325
350
[PR # 5386]: https://github.com/open-telemetry/opentelemetry.io/pull/5386/files
351
+ [slack] : https://slack.cncf.io/
0 commit comments