Skip to content

Commit a363f5d

Browse files
author
zacharysarah
committed
Add guidelines for working with localized content
1 parent a81ba11 commit a363f5d

2 files changed

Lines changed: 21 additions & 6 deletions

File tree

content/en/docs/contribute/intermediate.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -806,6 +806,18 @@ content. See [Localization](/docs/contribute/localization/) and ask on the
806806
[kubernetes-sig-docs mailing list](https://groups.google.com/forum/#!forum/kubernetes-sig-docs)
807807
or in `#sig-docs` on Slack if you are interested in helping out.
808808
809+
### Working with localized content
810+
811+
Follow these guidelines for working with localized content:
812+
813+
- Limit PRs to a single language.
814+
815+
Each language has its own reviewers and approvers.
816+
817+
- Reviewers, verify that PRs contain changes to only one language.
818+
819+
If a PR contains changes to source in more than one language, ask the PR contributor to open separate PRs for each language.
820+
809821
{{% /capture %}}
810822
811823
{{% capture whatsnext %}}

content/en/docs/contribute/start.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,7 @@ code repositories, refer to
2424

2525
## The basics about our docs
2626

27-
The Kubernetes documentation is written in Markdown and processed and deployed
28-
using Hugo. The source is in Github at
29-
[https://github.com/kubernetes/website](https://github.com/kubernetes/website).
30-
Most of the documentation source is stored in `/content/en/docs/`. Some of the
31-
reference documentation is automatically generated from scripts in the
32-
`update-imported-docs/` directory.
27+
The Kubernetes documentation is written in Markdown and processed and deployed using Hugo. The source is in Github at [https://github.com/kubernetes/website](https://github.com/kubernetes/website). Most of the documentation source is stored in `/content/en/docs/`. Some of the reference documentation is automatically generated from scripts in the `update-imported-docs/` directory.
3328

3429
You can file issues, edit content, and review changes from others, all from the
3530
Github website. You can also use Github's embedded history and search tools.
@@ -70,6 +65,14 @@ We make use of the standard Hugo shortcodes, as well as a few that are custom to
7065
the Kubernetes documentation. See [Custom Hugo shortcodes](/docs/contribute/style/hugo-shortcodes/) for
7166
information about how to use them.
7267

68+
### Multiple languages
69+
70+
Documentation source is available in multiple languages in `/content/`. Each language has its own folder with a two-letter code determined by the [ISO 639-1 standard](https://www.loc.gov/standards/iso639-2/php/code_list.php). For example, English documentation source is stored in `/content/en/docs/`.
71+
72+
For more information about contributing to documentation in multiple languages, see ["Working with localized content"](/docs/contribute/intermediate#working-with-localized-content) in the intermediate contributing guide.
73+
74+
For more information about localizing Kubernetes documentation, see ["Localization"](/docs/contribute/localization/).
75+
7376
## File actionable issues
7477

7578
Anyone with a Github account can file an issue (bug report) against the

0 commit comments

Comments
 (0)