Allow localization teams to review their own strings #27408

sftim · 2021-04-05T14:14:46Z

Allow localization teams to review the strings for their own localization, by moving the localized strings so they are each in their own directory, with their own OWNERS file.

Also tidy https://kubernetes.io/docs/contribute/localization/ to make the changed process easier to find, whether you are working on a new or an existing localization.

Fixes #26921

netlify · 2021-04-05T14:29:40Z

Deploy preview for kubernetes-io-master-staging ready!

Built with commit 3fbadac

https://deploy-preview-27408--kubernetes-io-master-staging.netlify.app

netlify · 2021-04-05T14:33:55Z

Deploy preview for kubernetes-io-master-staging ready!

Built with commit b0ad9ff

https://deploy-preview-27408--kubernetes-io-master-staging.netlify.app

content/en/docs/contribute/localization.md

kbhawkey · 2021-04-10T00:58:05Z

Page preview:
https://deploy-preview-27408--kubernetes-io-master-staging.netlify.app/docs/contribute/localization/

seokho-son · 2021-04-15T15:35:33Z

As a member of Korean localization team,
It looks good to me :)
Thank you @sftim

rikatz · 2021-04-15T17:23:04Z

data/i18n/pt/pt.toml

@@ -0,0 +1,225 @@
+ # i18n strings for the Portuguese (main) site.


maybe in the portuguese localization it is worth to already use pt-br instead of pt so we can merge this together with the #27413

Even if we don't merge this together, at least the destination file will have the correct name :)

raelga · 2021-04-15T17:35:45Z

/lgtm

Thanks @sftim, you are awesome!

k8s-ci-robot · 2021-04-15T17:35:56Z

LGTM label has been added.

Git tree hash: b23bb60d4c25136ba9399568c5610de0438ffd54

rikatz · 2021-04-15T17:39:17Z

@sftim left a minor nit, but can be corrected later for the movement of pt-br translation PR :)

content/en/docs/contribute/localization.md

kbhawkey · 2021-04-16T00:25:18Z

content/en/docs/contribute/localization.md

@@ -41,13 +44,54 @@ git clone https://github.com/<username>/website
 cd website
 ```

-### Open a pull request
+The localization you want to help out with is inside `content/<two-letter-code>`.


Line 47, could you add more of an intro. Something like:
The website content directory includes sub-directories for each language.
...

Done, I think.

kbhawkey · 2021-04-16T00:27:18Z

content/en/docs/contribute/localization.md


-For an example of adding a new localization, see the PR to enable [docs in French](https://github.com/kubernetes/website/pull/12548).
+If you notice a technical inaccuracy or other problem with the upstream (English)
+documentation, you should fix the upstream documentation first and then copy the


nit: Is "copy" the right word?
... you should fix the upstream documentation first and then translate (?) the updated content into your localization.

kbhawkey · 2021-04-16T00:28:07Z

content/en/docs/contribute/localization.md

+documentation, you should fix the upstream documentation first and then copy the
+fix into the localization you're working on.
+
+Please limit pull requests to a single localization, since pull requests that change


nit: This comes up again and again. Is it worthwhile to make this a note?

Please limit pull requests to a single localization

Sounds good. I'd prefer to add that callout in a separate PR, and keep this one focused on the change to localization reviewing.

content/en/docs/contribute/localization.md

kbhawkey · 2021-04-16T00:37:29Z

content/en/docs/contribute/localization.md

+
+Let Kubernetes SIG Docs know you're interested in creating a localization! Join the [SIG Docs Slack channel](https://kubernetes.slack.com/messages/sig-docs) and the [SIG Docs Localizations Slack channel](https://kubernetes.slack.com/messages/sig-docs-localizations). Other localization teams are happy to help you get started and answer any questions you have.
+
+Please also consider participating in the [SIG Docs Localization Subgroup meeting](https://github.com/kubernetes/community/tree/master/sig-docs).  The mission of the SIG Docs localization subgroup is to work across the SIG Docs localization teams to collaborate on defining and documenting the processes for creating localized contribution guides. In addition, the SIG Docs localization subgroup will look for opportunities for the creation and sharing of common tools across localization teams and also serve to identify new requirements to the SIG Docs Leadership team.  If you have questions about this meeting, please inquire on the [SIG Docs Localizations Slack channel](https://kubernetes.slack.com/messages/sig-docs-localizations).


Possibly reword:
The mission of the SIG Docs localization subgroup is to create a collaboration between the SIG Docs localization teams and define and document the processes for creating localized contribution guides.

I didn't change this wording from the original (previously line 78). Maybe something to fix separately?

Sure. These are notes/suggested improvements.

kbhawkey · 2021-04-16T00:53:44Z

content/en/docs/contribute/localization.md


-To guide other localization contributors, add a new [`README-**.md`](https://help.github.com/articles/about-readmes/) to the top level of k/website, where `**` is the two-letter language code. For example, a German README file would be `README-de.md`.
+For example, for German the strings live in `data/i18n/de/de.toml`, and
+`i18n/de.toml` is a symbolic link.


Is i18n/de.toml the link or data/i18n/de/de.toml? See the previous example describing the link and file.

i18n/de.toml is the symbolic link and data/i18n/de/de.toml is its target.

I tweaked the wording here.

kbhawkey · 2021-04-16T00:54:33Z

content/en/docs/contribute/localization.md


-Provide guidance to localization contributors in the localized `README-**.md` file. Include the same information contained in `README.md` as well as:
+### Localize the community code of conduct


nit: Is Community Code of Conduct a legal doc? Capitalize?

I've retained the capitalization from the previous version (and it seems fine).

I've retained the capitalization as I found it. Fixing that could happen in a separate PR if needed.

kbhawkey · 2021-04-16T01:09:21Z

Changes look good. Requested a couple of minor updates. Thanks!

kbhawkey · 2021-04-19T23:21:45Z

Thanks @sftim
/approve

/cc @kubernetes/sig-docs-zh-reviews @kubernetes/sig-docs-ja-reviews @kubernetes/sig-docs-fr-reviews

Hold for more review, add more localization teams (for review) if needed.
Does this change affect any existing localization work?
/hold

k8s-ci-robot · 2021-04-19T23:22:02Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: kbhawkey

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [kbhawkey]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

kbhawkey · 2021-04-21T00:45:46Z

/hold cancel

sftim · 2021-04-25T10:06:49Z

rebased

sftim · 2021-04-25T10:07:27Z

@raelga you previously added LGTM - can you take another look?

- explain new localized strings - general tidying

kbhawkey · 2021-04-25T14:12:05Z

data/i18n/pt/pt.toml

@@ -0,0 +1,225 @@
+ # i18n strings for the Portuguese (main) site.


Hi @sftim .
Is this the correct way to include pt and pt-br localization string files?
Or is it: data/i18n/pt-br.toml
The theme has a shallow hierarchy (listing all localization string files under i18n).

kbhawkey · 2021-04-25T14:14:59Z

I think the changes look good, except for one question about the pt-br file location. Thanks.

sftim · 2021-04-26T08:40:20Z

The team for Brazilian Portuguese is the pt team. If we add a Portguese (Portugal) localization I would expect to share people across the two teams. They layout I proposed here is intentional.

kbhawkey · 2021-05-08T15:24:28Z

This PR is ready to move forward. Feel free to remove the hold.
Some preview pages:
https://deploy-preview-27408--kubernetes-io-master-staging.netlify.app/ko/docs/concepts/overview/
https://deploy-preview-27408--kubernetes-io-master-staging.netlify.app/de/docs/concepts/overview/
https://deploy-preview-27408--kubernetes-io-master-staging.netlify.app/es/docs/concepts/overview/
https://deploy-preview-27408--kubernetes-io-master-staging.netlify.app/id/docs/concepts/overview/
https://deploy-preview-27408--kubernetes-io-master-staging.netlify.app/zh/docs/concepts/overview/
https://deploy-preview-27408--kubernetes-io-master-staging.netlify.app/pt-br/docs/concepts/overview/

Thanks @sftim .
/lgtm
/hold

k8s-ci-robot · 2021-05-08T15:24:38Z

LGTM label has been added.

Git tree hash: f404d1dc8642af5d0f7474bdd8aa6ef850106846

sftim · 2021-05-10T08:12:19Z

/hold cancel

This can go live and we can iteratively add improvements.

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Apr 5, 2021

k8s-ci-robot requested review from jimangel and kbhawkey April 5, 2021 14:14

k8s-ci-robot added language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Apr 5, 2021

sftim force-pushed the 20210405_allow_localizations_maintain_own_strings branch 2 times, most recently from 4c1eaa7 to 960d700 Compare April 5, 2021 14:19

sftim mentioned this pull request Apr 5, 2021

i18n changes approvable by sig-localization teams #26921

Closed

seokho-son reviewed Apr 5, 2021

View reviewed changes

content/en/docs/contribute/localization.md Outdated Show resolved Hide resolved

sftim force-pushed the 20210405_allow_localizations_maintain_own_strings branch 2 times, most recently from 9b9fdd1 to 800835a Compare April 8, 2021 21:00

rikatz reviewed Apr 15, 2021

View reviewed changes

k8s-ci-robot assigned raelga Apr 15, 2021

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 15, 2021

kbhawkey reviewed Apr 16, 2021

View reviewed changes

content/en/docs/contribute/localization.md Outdated Show resolved Hide resolved

kbhawkey reviewed Apr 16, 2021

View reviewed changes

content/en/docs/contribute/localization.md Outdated Show resolved Hide resolved

kbhawkey reviewed Apr 16, 2021

View reviewed changes

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Apr 19, 2021

k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Apr 19, 2021

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Apr 21, 2021

sftim force-pushed the 20210405_allow_localizations_maintain_own_strings branch from 800835a to 7597bbb Compare April 25, 2021 10:06

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 25, 2021

sftim added 3 commits April 25, 2021 11:10

Allow localization teams to review their own strings

06e7be5

Add explanatory note about localized string OWNERS

40e7940

Revise localization guide

b0ad9ff

- explain new localized strings - general tidying

sftim force-pushed the 20210405_allow_localizations_maintain_own_strings branch from 7597bbb to b0ad9ff Compare April 25, 2021 10:10

kbhawkey reviewed Apr 25, 2021

View reviewed changes

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Apr 25, 2021

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label May 8, 2021

k8s-ci-robot assigned kbhawkey May 8, 2021

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 8, 2021

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label May 10, 2021

k8s-ci-robot merged commit 10196aa into kubernetes:master May 10, 2021

sftim deleted the 20210405_allow_localizations_maintain_own_strings branch May 10, 2021 08:15

sftim mentioned this pull request Nov 8, 2022

Add an explanatory comment to post_create_issue #36838

Closed

		@@ -0,0 +1,225 @@
		# i18n strings for the Portuguese (main) site.


		Let Kubernetes SIG Docs know you're interested in creating a localization! Join the [SIG Docs Slack channel](https://kubernetes.slack.com/messages/sig-docs) and the [SIG Docs Localizations Slack channel](https://kubernetes.slack.com/messages/sig-docs-localizations). Other localization teams are happy to help you get started and answer any questions you have.

		Please also consider participating in the [SIG Docs Localization Subgroup meeting](https://github.com/kubernetes/community/tree/master/sig-docs). The mission of the SIG Docs localization subgroup is to work across the SIG Docs localization teams to collaborate on defining and documenting the processes for creating localized contribution guides. In addition, the SIG Docs localization subgroup will look for opportunities for the creation and sharing of common tools across localization teams and also serve to identify new requirements to the SIG Docs Leadership team. If you have questions about this meeting, please inquire on the [SIG Docs Localizations Slack channel](https://kubernetes.slack.com/messages/sig-docs-localizations).


		Provide guidance to localization contributors in the localized `README-**.md` file. Include the same information contained in `README.md` as well as:
		### Localize the community code of conduct

Allow localization teams to review their own strings #27408

Allow localization teams to review their own strings #27408

Conversation

sftim commented Apr 5, 2021

netlify bot commented Apr 5, 2021

netlify bot commented Apr 5, 2021 • edited Loading

kbhawkey commented Apr 10, 2021

seokho-son commented Apr 15, 2021

Choose a reason for hiding this comment

raelga commented Apr 15, 2021

k8s-ci-robot commented Apr 15, 2021

rikatz commented Apr 15, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kbhawkey Apr 16, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kbhawkey Apr 16, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kbhawkey commented Apr 16, 2021

kbhawkey commented Apr 19, 2021

k8s-ci-robot commented Apr 19, 2021

kbhawkey commented Apr 21, 2021

sftim commented Apr 25, 2021

sftim commented Apr 25, 2021

Choose a reason for hiding this comment

kbhawkey commented Apr 25, 2021

sftim commented Apr 26, 2021

kbhawkey commented May 8, 2021

k8s-ci-robot commented May 8, 2021

sftim commented May 10, 2021

netlify bot commented Apr 5, 2021 •

edited

Loading

kbhawkey Apr 16, 2021 •

edited

Loading

kbhawkey Apr 16, 2021 •

edited

Loading