Friday, April 26, 2019
How You Can Help Localize Kubernetes Docs
Author: Zach Corleissen (Linux Foundation)
Last year we optimized the Kubernetes website for hosting multilingual content. Contributors responded by adding multiple new localizations: as of April 2019, Kubernetes docs are partially available in nine different languages, with six added in 2019 alone. You can see a list of available languages in the language selector at the top of each page.
By partially available, I mean that localizations are ongoing projects. They range from mostly complete (Chinese docs for 1.12) to brand new (1.14 docs in Portuguese). If you’re interested in helping an existing localization, read on!
What is a localization?
Translation is about words and meaning. Localization is about words, meaning, process, and design.
A localization is like a translation, but more thorough. Instead of just translating words, a localization optimizes the framework for writing and publishing words. For example, most site navigation features (button text) on kubernetes.io are strings contained in a single file. Part of creating a new localization involves adding a language-specific version of that file and translating the strings it contains.
Localization matters because it reduces barriers to adoption and support. When we can read Kubernetes docs in our own language, it’s easier to get started using Kubernetes and contributing to its development.
How do localizations happen?
The availability of docs in different languages is a feature—and like all Kubernetes features, contributors develop localized docs in a SIG, share them for review, and add them to the project.
Contributors work in teams to localize content. Because folks can’t approve their own PRs, localization teams have a minimum size of two—for example, the Italian localization has two contributors. Teams can also be quite large: the Chinese team has several dozen contributors.
Each team has its own workflow. Some teams localize all content manually; others use editors with translation plugins and review machine output for accuracy. SIG Docs focuses on standards of output; this leaves teams free to adopt the workflow that works best for them. That said, teams frequently collaborate with each other on best practices, and sharing abounds in the best spirit of the Kubernetes community.
Helping with localizations
If you’re interested in starting a new localization for Kubernetes docs, the Kubernetes contribution guide shows you how.
Existing localizations also need help. If you’d like to contribute to an existing project, join the localization team’s Slack channel and introduce yourself. Folks on that team can help you get started.
| Localization | Slack channel |
|---|---|
| Chinese (中文) | #kubernetes-docs-zh |
| English | #sig-docs |
| French (Français) | #kubernetes-docs-fr |
| German (Deutsch) | #kubernetes-docs-de |
| Hindi | #kubernetes-docs-hi |
| Indonesian | #kubernetes-docs-id |
| Italian | #kubernetes-docs-it |
| Japanese (日本語) | #kubernetes-docs-ja |
| Korean (한국어) | #kubernetes-docs-ko |
| Portuguese (Português) | #kubernetes-docs-pt |
| Spanish (Español) | #kubernetes-docs-es |
What’s next?
There’s a new Hindi localization beginning. Why not add your language, too?
As a chair of SIG Docs, I’d love to see localization spread beyond the docs and into Kubernetes components. Is there a Kubernetes component you’d like to see supported in a different language? Consider making a Kubernetes Enhancement Proposal to support the change.