From c34ef23f3c0595011432011083d724b2bebc651a Mon Sep 17 00:00:00 2001 From: Zach Corleissen Date: Thu, 8 Nov 2018 10:51:39 -0800 Subject: [PATCH] Add blog post for l10n update (#10874) * Add blog post for l10n update Minor tweaks More minor tweakS Still more tweaks Yet more tweaks typo fix Add link to Shanghai KC+CNC Change date to 8 Nov * Update 2018-11-08-kubernetes-docs-update-i18n.md * Update 2018-11-08-kubernetes-docs-update-i18n.md --- .../2018-11-08-kubernetes-docs-update-i18n.md | 58 +++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 content/en/blog/_posts/2018-11-08-kubernetes-docs-update-i18n.md diff --git a/content/en/blog/_posts/2018-11-08-kubernetes-docs-update-i18n.md b/content/en/blog/_posts/2018-11-08-kubernetes-docs-update-i18n.md new file mode 100644 index 0000000000..1cf40bd820 --- /dev/null +++ b/content/en/blog/_posts/2018-11-08-kubernetes-docs-update-i18n.md @@ -0,0 +1,58 @@ +--- +layout: blog +title: 'Kubernetes Docs Updates, International Edition' +date: 2018-11-08 +--- + +**Author**: Zach Corleissen (Linux Foundation) + +As a co-chair of SIG Docs, I'm excited to share that Kubernetes docs have a fully mature workflow for localization (l10n). + +## Abbreviations galore + +L10n is an abbreviation for _localization_. + +I18n is an abbreviation for _internationalization_. + +I18n is [what you do](https://www.w3.org/International/questions/qa-i18n) to make l10n easier. L10n is a fuller, more comprehensive process than translation (_t9n_). + +## Why localization matters + +The goal of SIG Docs is to make Kubernetes easier to use for as many people as possible. + +One year ago, we looked at whether it was possible to host the output of a Chinese team working independently to translate the Kubernetes docs. After many conversations (including experts on OpenStack l10n), [much transformation](https://kubernetes.io/blog/2018/05/05/hugo-migration/), and [renewed commitment to easier localization](https://github.com/kubernetes/website/pull/10485), we realized that open source documentation is, like open source software, an ongoing exercise at the edges of what's possible. + +Consolidating workflows, language labels, and team-level ownership may seem like simple improvements, but these features make l10n scalable for increasing numbers of l10n teams. While SIG Docs continues to iterate improvements, we've paid off a significant amount of technical debt and streamlined l10n in a single workflow. That's great for the future as well as the present. + +## Consolidated workflow + +Localization is now consolidated in the [kubernetes/website](https://github.com/kubernetes/website) repository. We've configured the Kubernetes CI/CD system, [Prow](https://github.com/kubernetes/test-infra/tree/master/prow), to handle automatic language label assignment as well as team-level PR review and approval. + +### Language labels + +Prow automatically applies language labels based on file path. Thanks to SIG Docs contributor [June Yi](https://github.com/kubernetes/test-infra/pull/9835), folks can also manually assign language labels in pull request (PR) comments. For example, when left as a comment on an issue or PR, this command assigns the label `language/ko` (Korean). + + +``` +/language ko +``` + +These repo labels let reviewers filter for PRs and issues by language. For example, you can now filter the k/website dashboard for [PRs with Chinese content](https://github.com/kubernetes/website/pulls?utf8=%E2%9C%93&q=is%3Aopen+is%3Apr+label%3Alanguage%2Fzh). + +### Team review + +L10n teams can now review and approve their own PRs. For example, review and approval permissions for English are [assigned in an OWNERS file](https://github.com/kubernetes/website/blob/master/content/en/OWNERS) in the top subfolder for English content. + +Adding `OWNERS` files to subdirectories lets localization teams review and approve changes without requiring a rubber stamp approval from reviewers who may lack fluency. + +## What's next + +We're looking forward to the [doc sprint in Shanghai](https://kccncchina2018english.sched.com/event/HVb2/contributor-summit-doc-sprint-additional-registration-required) to serve as a resource for the Chinese l10n team. + +We're excited to continue supporting the Japanese and Korean l10n teams, who are making excellent progress. + +If you're interested in localizing Kubernetes for your own language or region, check out our [guide to localizing Kubernetes docs](https://kubernetes.io/docs/contribute/localization/) and reach out to a [SIG Docs chair](https://github.com/kubernetes/community/tree/master/sig-docs#leadership) for support. + +### Get involved with SIG Docs + +If you're interested in Kubernetes documentation, come to a SIG Docs [weekly meeting](https://github.com/kubernetes/community/tree/master/sig-docs#meetings), or join [#sig-docs in Kubernetes Slack](https://kubernetes.slack.com/messages/C1J0BPD2M/details/).