@@ -235,22 +235,30 @@ For more details about the script, run `npm run check:i18n -- -h`.
235
235
To start a new localization for the OpenTelemetry website,
236
236
[raise an issue](https://github.com/open-telemetry/opentelemetry.io/issues/) to
237
237
share your interest to contribute. Tag all other individuals that are willing to
238
- write and review translations in the language you want to add. You need at least
239
- two potential contributors, three would be ideal . Include the following task
238
+ write and review translations in the language you want to add. ** You need at
239
+ least two potential contributors**, ideally three . Include the following task
240
240
list in your issue as well :
241
241
242
242
` ` ` markdown
243
- - [ ] List at least 2 contributors for the new language: ` <@gitHubHandle1>`,
244
- ` <@gitHubHandle2> ` , ...
245
- - [ ] Localize index page to `<your language> `
246
- - [ ] Create an issue label for `lang:<shortcode>`
247
- - [ ] Create org-level group for `<shortcode>` approvers
248
- - [ ] Update components owners for `content/<shortcode>`
243
+ - [ ] Contributors for the new language: @GITHUB_HANDLE1, @GITHUB_HANDLE2, ...
244
+ - [ ] Localize site homepage to YOUR_LANGUAGE_NAME
245
+ - [ ] Create an issue label for ` lang:LANG_ID `
246
+ - [ ] Create org-level group for `LANG_ID` approvers
247
+ - [ ] Update components owners for `content/LANG_ID`
248
+ - [ ] Set up spell checking, if a cSpell dictionary is available
249
249
` ` `
250
250
251
- For the ` <shortcode>` use the
252
- [ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) for the language you
253
- want to add.
251
+ Notes:
252
+
253
+ - For ` LANG_ID`, use an official
254
+ [ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) for the language you
255
+ want to add.
256
+ - Look for
257
+ [cSpell dictionaries](https://github.com/streetsidesoftware/cspell-dicts)
258
+ available as NPM packages
259
+ [@cspell/dict-LANG_ID](https://www.npmjs.com/search?q=%40cspell%2Fdict). If a
260
+ dictionary isn't available for your dialect or region, choose the closest
261
+ region. For an example of how to set this up, see [PR # 5386].
254
262
255
263
After you created that issue and have the required amount of contributors,
256
264
maintainers will ask you to provide a pull request with a translation of the
@@ -279,3 +287,4 @@ if you are an approver already.
279
287
280
288
[main] : https://github.com/open-telemetry/opentelemetry.io/commits/main/
281
289
[multilingual framework] : https://gohugo.io/content-management/multilingual/
290
+ [PR # 5386]: https://github.com/open-telemetry/opentelemetry.io/pull/5386/files
0 commit comments