Skip to content

Commit b2d1ff5

Browse files
svrnmtheletterf
andauthored
Add guidelines for starting new localizations (#5385)
Signed-off-by: svrnm <[email protected]> Signed-off-by: svrnm <[email protected]> Co-authored-by: Fabrizio Ferri-Benedetti <[email protected]>
1 parent f6fc333 commit b2d1ff5

File tree

2 files changed

+47
-11
lines changed

2 files changed

+47
-11
lines changed

content/en/docs/contributing/localization.md

+39-11
Original file line numberDiff line numberDiff line change
@@ -204,22 +204,50 @@ For more details about the script, run `npm run check:i18n -- -h`.
204204

205205
## New localizations
206206

207-
(Section To Be Completed soon with information about how to propose a new
208-
localization.)
207+
To start a new localization for the OpenTelemetry website,
208+
[raise an issue](https://github.com/open-telemetry/opentelemetry.io/issues/) to
209+
share your interest to contribute. Tag all other individuals that are willing to
210+
write and review translations in the language you want to add. You need at least
211+
two potential contributors, three would be ideal. Include the following task
212+
list in your issue as well:
209213

210-
<!--
214+
```markdown
215+
- [ ] List at least 2 contributors for the new language: `<@gitHubHandle1>`,
216+
`<@gitHubHandle2>`, ...
217+
- [ ] Localize index page to `<your language>`
218+
- [ ] Create an issue label for `lang:<shortcode>`
219+
- [ ] Create org-level group for `<shortcode>` approvers
220+
- [ ] Update components owners for `content/<shortcode>`
221+
```
222+
223+
For the `<shortcode>` use the
224+
[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) for the language you
225+
want to add.
211226

212-
cSpell:ignore: CODEOWNERSHIP Comms
227+
After you created that issue and have the required amount of contributors,
228+
maintainers will ask you to provide a pull request with a translation of the
229+
[index page](https://github.com/open-telemetry/opentelemetry.io/blob/main/content/en/_index.md).
230+
Make sure that maintainers are allowed to edit your PR, since they will add
231+
additional changes to your PR that are required to get your localization project
232+
started.
213233

214-
* Our website supports multiple languages already, so the translated content should live under main/content/<two_letter_code>
215-
* Our point of reference is how kubernetes is doing their localization, see https://github.com/kubernetes/website
216-
* We need at least 2 ppl owning that content, so that changes can be approved (CODEOWNERSHIP will help with that)
217-
* We can start with the translation been hidden until we reach a point where enough material is translated to go live (with maybe some blog post & announcements around it)
218-
* (Please anticipate that this is guidance on not a fixed set of rules)
234+
With your first PR merged maintainers will take care of setting up the issue
235+
label, the org-level group and the component owners.
219236

220-
As stated above this project requires a set of individuals that are happy to take on ownership for their language and work with SIG Comms on implementing this. So any discussion on this page "how to do it" needs to be preceded by a "I volunteer to co-own `<language>`"
237+
{{% alert title="Important" color="warning" %}}
221238

222-
-->
239+
You don't have to be an existing contributor to the OpenTelemetry project, to
240+
start a new localization. However you will not be added as a member of the
241+
[OpenTelemetry GitHub organization](https://github.com/open-telemetry/) or as a
242+
member of the approvers group for your localization. You will need to satisfy
243+
the requirements for becoming an established member and approver as outlined in
244+
the
245+
[membership guidelines](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md).
246+
247+
When starting the localization project, maintainers will treat your reviews as
248+
if you are an approver already.
249+
250+
{{% /alert %}}
223251

224252
[main]: https://github.com/open-telemetry/opentelemetry.io/commits/main/
225253
[multilingual framework]: https://gohugo.io/content-management/multilingual/

static/refcache.json

+8
Original file line numberDiff line numberDiff line change
@@ -3435,6 +3435,10 @@
34353435
"StatusCode": 200,
34363436
"LastSeen": "2024-01-18T19:02:13.980094-05:00"
34373437
},
3438+
"https://en.wikipedia.org/wiki/ISO_639-1": {
3439+
"StatusCode": 200,
3440+
"LastSeen": "2024-10-11T11:10:12.725968+02:00"
3441+
},
34383442
"https://en.wikipedia.org/wiki/In-band_signaling": {
34393443
"StatusCode": 200,
34403444
"LastSeen": "2024-01-18T19:01:54.201621-05:00"
@@ -7179,6 +7183,10 @@
71797183
"StatusCode": 200,
71807184
"LastSeen": "2024-06-13T15:48:00.42543+02:00"
71817185
},
7186+
"https://github.com/open-telemetry/opentelemetry.io/issues/": {
7187+
"StatusCode": 200,
7188+
"LastSeen": "2024-10-11T11:10:11.918895+02:00"
7189+
},
71827190
"https://github.com/open-telemetry/opentelemetry.io/issues/4427": {
71837191
"StatusCode": 200,
71847192
"LastSeen": "2024-05-06T15:32:24.49099-04:00"

0 commit comments

Comments
 (0)