Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Link more clearly to localized READMEs #10622

Closed
1 of 2 tasks
zacharysarah opened this issue Oct 16, 2018 · 3 comments
Closed
1 of 2 tasks

Link more clearly to localized READMEs #10622

zacharysarah opened this issue Oct 16, 2018 · 3 comments
Assignees

Comments

@zacharysarah
Copy link
Contributor

zacharysarah commented Oct 16, 2018

This is a...

  • Feature Request
  • Bug Report

Problem

We can make it easier for localization teams to find README-**.md files (where ** is a two-letter language code) by linking to them from the main README and/or from the localization guidelines.

Continuing #10485 (comment) as a separate issue:

@claudiajkang 👋

I'm sorry but I think you've miss understood my fourth review.

I apologize! 🙇 To make sure I understand, here are the specific actions I see proposed in your feedback. Are these correct? 👇

Proposed Solution

  1. Update /content/en/docs/contribute/localization.md to include links to various README-**.md files.

Another idea to suggest is adding README-.md example url in localization.md after this PR.
If so, localization team would be easier to create README-
.md configuration.

  1. Add a link to various README-**.md files from the main English README.md file.

After you create the localized README, add a link to the file from the main English file, [README.md]

  1. Require README-**.md files to include contact information in English.

and include contact information in English.

@claudiajkang Do I understand your proposal correctly? ☝️

If so, then:

So, how about adding README-**.md link in README.md like above?

A. I think updating the main README.md is an excellent idea. 👍

B. I'm ambivalent about adding README-**.md links to localization.md. 😐

Ideally contributors with a README-** available in their language would be reading localization.md in that language as well, in which case the links would be circular. That's not inherently bad; I'm just not convinced that it's good.

Page to Update:

/cc @tnir @idealhack

@claudiajkang
Copy link
Contributor

Sorry for not replying sooner.

And I think you've exactly understood my proposal!

A. I think updating the main README.md is an excellent idea. 👍

In case of A, Thank you for your opinion, I appreciate it!

B. I'm ambivalent about adding README-**.md links to localization.md. 😐

In case of B, I agree with your opinion.

But what do you think of adding a link process about the file README-**.md in localication.md?

For example, it replace [README.md] to [README.md's Localizing Kubernetes Documentation] in localication.md.

After you create the localized README, add a link to the file from the main English file, [README.md's Localizing Kubernetes Documentation] and include contact information in English. You can provide a GitHub ID, email address, Slack channel, or other method of contact.

If so, localization team would be easier to add link README-**.md!

@zacharysarah
Copy link
Contributor Author

@claudiajkang 👋

If so, localization team would be easier to add link README-**.md!

That's a good point! ✨

So any PR that addresses this issue needs to specify that localizations of localization.md must link to the appropriate README-**.md file.

claudiajkang added a commit to claudiajkang/website2 that referenced this issue Oct 18, 2018
This commit adds a link about Localizing Kubernetes Documentation in
README.md's Contributing to the docs section.

Fixed : kubernetes#10485, kubernetes#10622

Signed-off-by: Claudia J. Kang <claudiajkang@gmail.com>
claudiajkang added a commit to claudiajkang/website2 that referenced this issue Oct 18, 2018
This commit adds a link process about the l10n README files in
localization.md.

Fixed : kubernetes#10485, kubernetes#10622

Signed-off-by: Claudia J. Kang <claudiajkang@gmail.com>
@claudiajkang
Copy link
Contributor

@zacharysarah Thank you! I created #10669 PR about this issue. 😄

k8s-ci-robot pushed a commit that referenced this issue Oct 23, 2018
* New link about Localizing Kubernetes Documentation

This commit adds a link about Localizing Kubernetes Documentation in
README.md's Contributing to the docs section.

Fixed : #10485, #10622

Signed-off-by: Claudia J. Kang <claudiajkang@gmail.com>

* Update l10n guide about adding l10n README files.

This commit adds a link process about the l10n README files in
localization.md.

Fixed : #10485, #10622

Signed-off-by: Claudia J. Kang <claudiajkang@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants