Skip to content
Permalink
Browse files

Add guidelines for working with localized content (#11415)

Clarify about where to look for specific l10n tasks

More accurate link pointer

Update link for upstream contributions
  • Loading branch information...
zacharysarah authored and k8s-ci-robot committed Nov 30, 2018
1 parent a81ba11 commit d1df4b643710ecb7ddd26e687b2cd9e1638a757f
@@ -806,6 +806,18 @@ content. See [Localization](/docs/contribute/localization/) and ask on the
[kubernetes-sig-docs mailing list](https://groups.google.com/forum/#!forum/kubernetes-sig-docs)
or in `#sig-docs` on Slack if you are interested in helping out.

### Working with localized content

Follow these guidelines for working with localized content:

- Limit PRs to a single language.

Each language has its own reviewers and approvers.

- Reviewers, verify that PRs contain changes to only one language.

If a PR contains changes to source in more than one language, ask the PR contributor to open separate PRs for each language.

{{% /capture %}}

{{% capture whatsnext %}}
@@ -203,7 +203,7 @@ For more information about working from forks or directly from the repository, s

### Upstream contributions

SIG Docs welcomes upstream contributions and corrections to the English source! Open a [pull request](https://kubernetes.io/docs/contribute/start/#improve-existing-content) (from a fork) with any updates.
SIG Docs welcomes [upstream contributions and corrections](/docs/contribute/intermediate#localize-content) to the English source.

{{% /capture %}}

@@ -24,12 +24,7 @@ code repositories, refer to

## The basics about our docs

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.
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.

You can file issues, edit content, and review changes from others, all from the
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
the Kubernetes documentation. See [Custom Hugo shortcodes](/docs/contribute/style/hugo-shortcodes/) for
information about how to use them.

### Multiple languages

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/`.

For more information about contributing to documentation in multiple languages, see ["Localize content"](/docs/contribute/intermediate#localize-content) in the intermediate contributing guide.

If you're interested in starting a new localization, see ["Localization"](/docs/contribute/localization/).

## File actionable issues

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

0 comments on commit d1df4b6

Please sign in to comment.
You can’t perform that action at this time.