Skip to content

Commit

Permalink
Update localization guidelines for language labels
Browse files Browse the repository at this point in the history
  • Loading branch information
zacharysarah committed Oct 3, 2018
1 parent 86c0e43 commit 76a9621
Showing 1 changed file with 27 additions and 9 deletions.
36 changes: 27 additions & 9 deletions content/en/docs/contribute/localization.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,18 @@ content_template: templates/concept
approvers:
- chenopis
- zacharysarah
- zparnold
---

{{% capture overview %}}

The Kubernetes documentation is currently available in [multiple languages](#supported-languages) and we encourage you to add new localizations ([l10n](https://blog.mozilla.org/l10n/2011/12/14/i18n-vs-l10n-whats-the-diff/))!
Documentation for Kubernetes is available in [multiple languages](#supported-languages). We encourage you to add new localizations ([l10n](https://blog.mozilla.org/l10n/2011/12/14/i18n-vs-l10n-whats-the-diff/))!

Currently available languages:

{{< language-repos-list >}}

In order for localizations to be accepted, however, they must fulfill some requirements related to workflow (*how* to localize) and output (*what* to localize).
Localizations must meet some requirements for workflow (*how* to localize) and output (*what* to localize).

{{% /capture %}}

Expand All @@ -24,29 +25,42 @@ In order for localizations to be accepted, however, they must fulfill some requi

## Workflow

The Kubernetes documentation for all languages is built from the [kubernetes/website](https://github.com/kubernetes/website) repository on GitHub. Most day-to-work work on translations, however, happens in separate translation repositories. Changes to those repositories are then [periodically](#upstream-contributions) synced to the main kubernetes/website repository via [pull request](../create-pull-request).

Work on the Chinese translation, for example, happens in the [kubernetes/kubernetes-docs-zh](https://github.com/kubernetes/kubernetes-docs-zh) repository.
The [kubernetes/website](https://github.com/kubernetes/website) repository contains Kubernetes documentation in all languages. This includes ongoing translation work.

{{< note >}}
**Note**: For an example localization-related [pull request](../create-pull-request), see [this pull request](https://github.com/kubernetes/website/pull/8636) to the [Kubernetes website repo](https://github.com/kubernetes/website) adding Korean localization to the Kubernetes docs.
{{< /note >}}

## Source Files

Localizations must use English files from the most recent major release as sources. To find the most recent release's documentation source files:
Localizations must use English files from the most recent release as their source. The most recent version is **{{< latest-version >}}**.

To find source files for the most recent release:

1. Navigate to the Kubernetes website repository at https://github.com/kubernetes/website.
2. Select the `release-1.X` branch for the most recent version, which is currently **{{< latest-version >}}**, making the most recent release branch [`{{< release-branch >}}`](https://github.com/kubernetes/website/tree/{{< release-branch >}}).
2. Select the `release-1.X` branch for the most recent version.

{{< note >}}
**Note:** The latest version is **{{< latest-version >}}**, so the most recent release branch is [`{{< release-branch >}}`](https://github.com/kubernetes/website/tree/{{< release-branch >}}).
{{< /note >}}

## Getting started

In order to add a new localization of the Kubernetes documentation, you'll need to make a few modifications to the site's [configuration](#configuration) and [directory structure](#new-directory), and then you can get to work [translating documents](#translating-documents)!
In order to add a new localization of the Kubernetes documentation, you'll need to modify the site's [configuration](#configuration) and [directory structure](#new-directory), and then you can get to work [translating documents](#translating-documents)!

1. Let us know so we can help you
2. Modify the site configuration
3. Add your l10n to the site directory structure

### Fork and clone the repo

Begin by creating [your own fork](https://help.github.com/articles/fork-a-repo/) of the kubernetes/website repo:


To get started, clone the website repo and `cd` into it:

```shell
git clone https://github.com/kubernetes/website
git clone https://github.com/<username-or-organization>/website.git
cd website
git checkout {{< release-branch >}}
```
Expand Down Expand Up @@ -131,6 +145,10 @@ Projects must include at least these columns:

Each l10n repository must have branches for the different Kubernetes documentation release versions, matching the branches in the main [kubernetes/website](https://github.com/kubernetes/website) documentation repository. For example, the kubernetes/website `release-1.10` branch (https://github.com/kubernetes/website/tree/release-1.10) has a corresponding branch in the kubernetes/kubernetes-docs-zh repository (https://github.com/kubernetes/kubernetes-docs-zh/tree/release-1.10). These version branches keep track of the differences in the documentation between Kubernetes versions.

### Setting up subtrees



### Upstream contributions

Upstream contributions are welcome and encouraged!
Expand Down

0 comments on commit 76a9621

Please sign in to comment.