Skip to content

Commit

Permalink
add some guidelines for localization teams (cncf#1075)
Browse files Browse the repository at this point in the history
* add some guidelines for localization teams

Signed-off-by: Noah Ispas (iamNoah1) <noahispas@gmail.com>

* Small edits

Co-authored-by: Catherine Paganini <74001907+CathPag@users.noreply.github.com>
Signed-off-by: Jason (Jay) Smith <jaysmith@google.com>
  • Loading branch information
2 people authored and jasonsmithio committed Sep 7, 2022
1 parent 1808e09 commit 7b392d2
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions LOCALIZATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ we'd love to start localizing it into different languages.

- [Initiate a new localization team](#initiating-a-new-localization-team)
- [Join an existing localization team](#join-an-existing-localization-team)
- [Localization team guidelines](#localization-team-guidelines)

Contributions to improving the following localization guides and localization policies are also welcome.

Expand Down Expand Up @@ -132,6 +133,14 @@ Once the PR is merged, the localized content will go live on its website 🎉

To join an existing team, hop on the #glossary-localizations and #glossary-localization-[language name] channels on the CNCF Slack. Introduce yourself, let the team know you want to contribute, and the team will take it from there.

If the team seems inactive (no response after several days), reach out to @Seokho Son, @Catherine Paganini, and @jmo on the #glossary-localizations channel.
If the team seems inactive (no response after several days), reach out to @Seokho Son, @Catherine Paganini, @jmo, @Jihoon Seo or @Noah Ispas on the #glossary-localizations channel.

Note, that every localization team may have their own process of working on localizing terms. However, one thing is common for all localization teams and important to keep in mind: Contributions have to be based on the `dev-xx` branch and PRs need to target `dev-xx`.
---

# Localization team guidelines
Every localization team may have its own process of working on localizing terms. However, here are some guidelines that are common for all localization teams:

1. Only terms with the status `Completed` in the English version are ready to be localized.
2. All contributions related to localization have to be based on the `dev-xx` branch, and PRs need to target `dev-xx`.
3. Localization teams need to get changes from the `main` branch in their `dev-xx` branch from time to time. Therefore a PR should be opened where the `main` branch is merged into `dev-xx`. The glossary maintainers will then choose the rebase method to complete the PR and keep the history linear.
4. A localized term does not have to match the English version completely. Also, the localized and English versions of terms can coexist independently throughout updates. Localization teams can decide to which degree localized terms have to match their English version and how to handle updates on the English term.

0 comments on commit 7b392d2

Please sign in to comment.