Skip to content

Commit 3f373fd

Browse files
authored
Merge pull request #25795 from shu-mutou/update-l10n
Fix `Source files` in localization document.
2 parents 903ee36 + de1b4d7 commit 3f373fd

File tree

1 file changed

+29
-19
lines changed

1 file changed

+29
-19
lines changed

content/en/docs/contribute/localization.md

Lines changed: 29 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Members of `@kubernetes/sig-docs-**-owners` can approve PRs that change content
6161

6262
For each localization, The `@kubernetes/sig-docs-**-reviews` team automates review assignment for new PRs.
6363

64-
Members of `@kubernetes/website-maintainers` can create new development branches to coordinate translation efforts.
64+
Members of `@kubernetes/website-maintainers` can create new localization branches to coordinate translation efforts.
6565

6666
Members of `@kubernetes/website-milestone-maintainers` can use the `/milestone` [Prow command](https://prow.k8s.io/command-help) to assign a milestone to issues or PRs.
6767

@@ -205,14 +205,20 @@ To ensure accuracy in grammar and meaning, members of your localization team sho
205205

206206
### Source files
207207

208-
Localizations must be based on the English files from the most recent release, {{< latest-version >}}.
208+
Localizations must be based on the English files from a specific release targeted by the localization team.
209+
Each localization team can decide which release to target which is referred to as the _target version_ below.
209210

210-
To find source files for the most recent release:
211+
To find source files for your target version:
211212

212213
1. Navigate to the Kubernetes website repository at https://github.com/kubernetes/website.
213-
2. Select the `release-1.X` branch for the most recent version.
214+
2. Select a branch for your target version from the following table:
215+
Target version | Branch
216+
-----|-----
217+
Next version | [`dev-{{< skew nextMinorVersion >}}`](https://github.com/kubernetes/website/tree/dev-{{< skew nextMinorVersion >}})
218+
Latest version | [`master`](https://github.com/kubernetes/website/tree/master)
219+
Previous version | `release-*.**`
214220

215-
The latest version is {{< latest-version >}}, so the most recent release branch is [`{{< release-branch >}}`](https://github.com/kubernetes/website/tree/{{< release-branch >}}).
221+
The `master` branch holds content for the current release `{{< latest-version >}}`. The release team will create `{{< release-branch >}}` branch shortly before the next release: v{{< skew nextMinorVersion >}}.
216222

217223
### Site strings in i18n
218224

@@ -239,37 +245,43 @@ Some language teams have their own language-specific style guide and glossary. F
239245

240246
## Branching strategy
241247

242-
Because localization projects are highly collaborative efforts, we encourage teams to work in shared development branches.
248+
Because localization projects are highly collaborative efforts, we encourage teams to work in shared localization branches.
243249

244-
To collaborate on a development branch:
250+
To collaborate on a localization branch:
245251

246-
1. A team member of [@kubernetes/website-maintainers](https://github.com/orgs/kubernetes/teams/website-maintainers) opens a development branch from a source branch on https://github.com/kubernetes/website.
252+
1. A team member of [@kubernetes/website-maintainers](https://github.com/orgs/kubernetes/teams/website-maintainers) opens a localization branch from a source branch on https://github.com/kubernetes/website.
247253

248254
Your team approvers joined the `@kubernetes/website-maintainers` team when you [added your localization team](#add-your-localization-team-in-github) to the [`kubernetes/org`](https://github.com/kubernetes/org) repository.
249255

250256
We recommend the following branch naming scheme:
251257

252258
`dev-<source version>-<language code>.<team milestone>`
253259

254-
For example, an approver on a German localization team opens the development branch `dev-1.12-de.1` directly against the k/website repository, based on the source branch for Kubernetes v1.12.
260+
For example, an approver on a German localization team opens the localization branch `dev-1.12-de.1` directly against the k/website repository, based on the source branch for Kubernetes v1.12.
255261

256-
2. Individual contributors open feature branches based on the development branch.
262+
2. Individual contributors open feature branches based on the localization branch.
257263

258264
For example, a German contributor opens a pull request with changes to `kubernetes:dev-1.12-de.1` from `username:local-branch-name`.
259265

260-
3. Approvers review and merge feature branches into the development branch.
266+
3. Approvers review and merge feature branches into the localization branch.
261267

262-
4. Periodically, an approver merges the development branch to its source branch by opening and approving a new pull request. Be sure to squash the commits before approving the pull request.
268+
4. Periodically, an approver merges the localization branch to its source branch by opening and approving a new pull request. Be sure to squash the commits before approving the pull request.
263269

264-
Repeat steps 1-4 as needed until the localization is complete. For example, subsequent German development branches would be: `dev-1.12-de.2`, `dev-1.12-de.3`, etc.
270+
Repeat steps 1-4 as needed until the localization is complete. For example, subsequent German localization branches would be: `dev-1.12-de.2`, `dev-1.12-de.3`, etc.
265271

266-
Teams must merge localized content into the same release branch from which the content was sourced. For example, a development branch sourced from {{< release-branch >}} must be based on {{< release-branch >}}.
272+
Teams must merge localized content into the same branch from which the content was sourced.
267273

268-
An approver must maintain a development branch by keeping it current with its source branch and resolving merge conflicts. The longer a development branch stays open, the more maintenance it typically requires. Consider periodically merging development branches and opening new ones, rather than maintaining one extremely long-running development branch.
274+
For example:
275+
- a localization branch sourced from `master` must be merged into `master`.
276+
- a localization branch sourced from `release-1.19` must be merged into `release-1.19`.
269277

270-
At the beginning of every team milestone, it's helpful to open an issue comparing upstream changes between the previous development branch and the current development branch. There are two scripts for comparing upstream changes. [`upstream_changes.py`](https://github.com/kubernetes/website/tree/master/scripts#upstream_changespy) is useful for checking the changes made to a specific file. And [`diff_l10n_branches.py`](https://github.com/kubernetes/website/tree/master/scripts#diff_l10n_branchespy) is useful for creating a list of outdated files for a specific localization branch.
278+
{{< note >}}
279+
If your localization branch was created from `master` branch but it is not merged into `master` before new release branch `{{< release-branch >}}` created, merge it into both `master` and new release branch `{{< release-branch >}}`. To merge your localization branch into new release branch `{{< release-branch >}}`, you need to switch upstream branch of your localization branch to `{{< release-branch >}}`.
280+
{{< /note >}}
271281

272-
While only approvers can open a new development branch and merge pull requests, anyone can open a pull request for a new development branch. No special permissions are required.
282+
At the beginning of every team milestone, it's helpful to open an issue comparing upstream changes between the previous localization branch and the current localization branch. There are two scripts for comparing upstream changes. [`upstream_changes.py`](https://github.com/kubernetes/website/tree/master/scripts#upstream_changespy) is useful for checking the changes made to a specific file. And [`diff_l10n_branches.py`](https://github.com/kubernetes/website/tree/master/scripts#diff_l10n_branchespy) is useful for creating a list of outdated files for a specific localization branch.
283+
284+
While only approvers can open a new localization branch and merge pull requests, anyone can open a pull request for a new localization branch. No special permissions are required.
273285

274286
For more information about working from forks or directly from the repository, see ["fork and clone the repo"](#fork-and-clone-the-repo).
275287

@@ -290,5 +302,3 @@ Once a localization meets requirements for workflow and minimum output, SIG docs
290302

291303
- Enable language selection on the website
292304
- Publicize the localization's availability through [Cloud Native Computing Foundation](https://www.cncf.io/about/) (CNCF) channels, including the [Kubernetes blog](https://kubernetes.io/blog/).
293-
294-

0 commit comments

Comments
 (0)