Localizing Kubernetes Documentation
We’re happy to add localizations (l10n) of Kubernetes documentation to the website!
Localizations must meet the following requirements for workflow (how to localize) and output (what to localize).
Workflow
All l10n work must be stored and tracked within the Kubernetes organization.
Basis for localizations
Localizations must source from the English files for the most recent major release.
Note: To find the most recent release’s documentation source files:
- Navigate to https://github.com/kubernetes/website.
-
Select the
release-1.Xbranch for the most recent version.For example, the branch for Kubernetes v1.9 docs is
release-1.9.
Source files reside in the /docs/ directory.
Repository
A l10n team will have a repository specifically dedicated to its work, for example: kubernetes/kubernetes-docs-cn.
Note: To open a l10n repository, contact the SIG docs lead on Slack for assistance.
Project
Teams must track their overall progress with a GitHub project.
Projects must include columns for:
- To do
- In progress
- Done
For example: the Chinese localization project.
Team function
L10n teams must provide a single point of contact: the name and contact information of a person who can respond to or redirect questions or concerns.
L10n teams must provide their own repository maintainers.
All l10n work must be self-sustaining with the team’s own resources.
Wherever possible, every localized page must be approved by a reviewer from a different company than the translator.
Upstream contributions
Upstream contributions are welcome and encouraged!
For the sake of efficiency, limit upstream contributions to a single pull request per week, containing a single squashed commit.
Output
All localizations must include the following documentation at a minimum:
| Description | URLs |
|---|---|
| Home | All heading and subheading URLs |
| Setup | All heading and subheading URLs |
| Tutorials | Kubernetes Basics, Hello Minikube |
Next steps
Once a l10n meets requirements for workflow and minimum output, SIG docs will:
- Work with the localization team to implement language selection on the website
- Publicize availability through Cloud Native Computing Foundation (CNCF) channels.
Note: Implementation of language selection is pending Kubernetes’ first completed localization project.