Skip to content

Commit 36e40bc

Browse files
committed
[i18n] Mention spell checker requirement for new localizations
1 parent 4c5468f commit 36e40bc

File tree

2 files changed

+32
-11
lines changed

2 files changed

+32
-11
lines changed

content/en/docs/contributing/localization.md

+20-11
Original file line numberDiff line numberDiff line change
@@ -235,22 +235,30 @@ For more details about the script, run `npm run check:i18n -- -h`.
235235
To start a new localization for the OpenTelemetry website,
236236
[raise an issue](https://github.com/open-telemetry/opentelemetry.io/issues/) to
237237
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
240240
list in your issue as well:
241241

242242
```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
249249
```
250250
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].
254262

255263
After you created that issue and have the required amount of contributors,
256264
maintainers will ask you to provide a pull request with a translation of the
@@ -279,3 +287,4 @@ if you are an approver already.
279287

280288
[main]: https://github.com/open-telemetry/opentelemetry.io/commits/main/
281289
[multilingual framework]: https://gohugo.io/content-management/multilingual/
290+
[PR #5386]: https://github.com/open-telemetry/opentelemetry.io/pull/5386/files

static/refcache.json

+12
Original file line numberDiff line numberDiff line change
@@ -7271,6 +7271,10 @@
72717271
"StatusCode": 200,
72727272
"LastSeen": "2024-01-30T15:26:01.154768-05:00"
72737273
},
7274+
"https://github.com/open-telemetry/opentelemetry.io/pull/5386/files": {
7275+
"StatusCode": 200,
7276+
"LastSeen": "2024-11-02T12:26:48.450866-04:00"
7277+
},
72747278
"https://github.com/open-telemetry/opentelemetry.io/pulls": {
72757279
"StatusCode": 200,
72767280
"LastSeen": "2024-01-30T16:15:25.833527-05:00"
@@ -7843,6 +7847,10 @@
78437847
"StatusCode": 200,
78447848
"LastSeen": "2024-02-15T11:30:50.628118+01:00"
78457849
},
7850+
"https://github.com/streetsidesoftware/cspell-dicts": {
7851+
"StatusCode": 200,
7852+
"LastSeen": "2024-11-02T12:26:45.305184-04:00"
7853+
},
78467854
"https://github.com/strimzi": {
78477855
"StatusCode": 200,
78487856
"LastSeen": "2024-01-18T20:05:40.859417-05:00"
@@ -13403,6 +13411,10 @@
1340313411
"StatusCode": 200,
1340413412
"LastSeen": "2024-01-18T19:55:41.775458-05:00"
1340513413
},
13414+
"https://www.npmjs.com/search": {
13415+
"StatusCode": 200,
13416+
"LastSeen": "2024-11-02T12:26:46.909401-04:00"
13417+
},
1340613418
"https://www.nuget.org/packages/": {
1340713419
"StatusCode": 200,
1340813420
"LastSeen": "2024-01-30T15:25:18.124486-05:00"

0 commit comments

Comments
 (0)