kubernetes / website

Kubernetes website and documentation repo:
https://kubernetes.io
Creative Commons Attribution 4.0 International
4.46k stars 14.36k forks source link

Test translation tooling for localizations #45756

Open a-mccarthy opened 6 months ago

a-mccarthy commented 6 months ago

Breaking out from https://github.com/kubernetes/website/issues/45175 and https://github.com/kubernetes/website/discussions/45209, this issue focuses on forming a team to test out different TLMP tools for use to localize Kubernetes docs, including creating a prototype. Special thanks to @sftim for help reviewing the testing plan/requirements.

If you would like to participate, please respond by Monday, April 22nd with your interest.

Outcomes of the testing phase:

During this testing phase we'd like to identify the technical requirements necessary to integrate a TLMP such as Transifex or Crowdin into this kubernetes/website repository.

At the end of the phase we should have:


Testing phase timeline

To be determined, depends on finding volunteers to help do the testing.


Resources

To do the testing we'd like the following roles filled with folks from the community. The testing phase will last about 1 month and has light some time requires depending on the role you'd like to help out with (described below).

Volunteers for this testing should be is able to

  1. read/write a language other than English
  2. has some experience with our current localizing and reviewing processes
  3. commit to helping for the entire testing phase. You wont necessarily have work for the entire time, but we'd ask that volunteers can commit to be responsive on slack and GitHub for the testing phase.
  4. Volunteers should also be Kubernetes Github Org members.

If you have experience with these tools already, great! But you do not need to know anything about the tooling to be a volunteer here, having a new users experience is very valuable for our testing.

We'd also be interested in having a whole language team, or part of a team, participate in the testing. That way we'd be able to test the whole workflow, from localizing content, reviewing it, and "publishing" it.

Roles

TLMP administrator: We need two (or more) people to look after the prototype TLMP and either shut it down at the end of the prototype phase, or update it for adoption. The two person minimum comes from not wanting to rely on any single contributor; we could otherwise end up in a situation where we have a platform we can't manage. These contributors may also join a Google Group or similar, associated with the TLMP's owner identity.

Communication Lead: We need one person to lead communication for the testing. They will help share progress and highlight blockers for the testing teams. This person should be available to attend SIG meetings for sharing updates to SIG docs

Technical lead: We should involve one of the SIG's technical leads as liaison and to either contribute to the report to the SIG, or to review it. The person should also be available to answer questions during the testing phase

Localization team: To make sure we are testing the workflows completely, we'd like to make sure we have testers and reviewers from the same language. We ask that volunteers for these roles sign up from the same localization team, and fill the roles for their specific language. There should be TLMP testers and localization reviewers for each language that chooses to participate.

Note: Ideally, testers and reviewers within a localization team are different people, which models how the localization workflow work now.

[Language] Team:

TLMP testers:

  1. [NAME - github]
  2. [NAME - github]

Localization reviewers:

  1. [NAME - github]
  2. [NAME - github]

Non goals

/area localization

electrocucaracha commented 4 months ago

I'm not sure if it's too late, but I'd like to participate as a TLMP tester for Spanish.

Andygol commented 3 months ago

I've updated the volunteer requirements to include "Volunteers should also be Kubernetes Github Org members." This to make sure that volunteers have any necessary repo permissions that come up during testing and a baseline familiarity with our policies. Please reach out if you have any questions :)

Does this mean that anyone who wants to participate in the test will be granted membership?

natalisucks commented 3 months ago

@Andygol no, it means that participants need to already be a member of the Kubernetes organization to participate โ€“ you can read more about how to gain membership here: https://github.com/kubernetes/community/blob/master/community-membership.md#member

Andygol commented 3 months ago

I've read https://github.com/kubernetes/community/blob/master/community-membership.md#member and can't wrap my mind around membership requirements for participation in the "Test translation tooling for localization". Could someone explain to me expected workflow of the testing. ๐Ÿ™

sftim commented 3 months ago

Could someone explain to me expected workflow of the testing. ๐Ÿ™

(example, high level)

The experience from people doing those steps informs the output from the testing phase.

Andygol commented 3 months ago

@sftim How all this ๐Ÿ‘‡ connected with having membership?

  • Pick a page to localize
  • Use the tool to localize the text of the page to a target language
  • Submit the page for review and publication
Andygol commented 3 months ago

https://crowdin.com/blog/2022/06/09/localize-your-software-with-crowdin#the-process-of-software-localization-step-by-step ๐Ÿ‘ˆ Here you may find top level overview of the continuous localization of software workflow

sftim commented 3 months ago

SIG Docs leadership are asking that people taking part in the trial are already members of the Kubernetes organization. Participation in the trial is optional, and I imagine that after a successful trial the tooling would be open to a wider group.

Andygol commented 3 months ago

SIG Docs leadership are asking that people taking part in the trial are already members of the Kubernetes organization.

I would like (and expect other people to) to get a membership to participate in the trial. Could someone walk me through the membership process, step by step, to be admitted to the trial?

natalisucks commented 3 months ago

I've read https://github.com/kubernetes/community/blob/master/community-membership.md#member and can't wrap my mind around membership requirements for participation in the "Test translation tooling for localization". Could someone explain to me expected workflow of the testing. ๐Ÿ™

SIG Docs leadership is looking for Kubernetes organization members for this testing so that all testers have the required permissions for LGTM'ing PRs, alongside showing an ongoing and long-term commitment to the project. This is important so that decisions by the group testing this tooling is done by folks who will continue contributing to Kubernetes documentation โ€“ they will have an impact on the localization they represent, so decisions should be made by Kubernetes org members.

@Andygol Unfortunately, participating in the trial does not automatically grant membership. Each localization has team members who are Kubernetes organization members so that they can review and approve PRs of their work. You can also start working, right now, towards your membership status by working on the necessary requirements listed. An example of someone having recently done so is @zilmarr โ€“ you can look at the issue they raised, with all their contributions listed for supporting their case, here: https://github.com/kubernetes/org/issues/4976

natalisucks commented 3 months ago

@a-mccarthy Do you have an update on the ongoing coordination and/or the start of this PoC work?

a-mccarthy commented 3 months ago

Thank you @natalisucks โค๏ธ

I've updated the list below with folks who have volunteered and are org members.

pt-br: @stormqueen1990, @zilmarr, @holgers66, @edsoncelio ar: @seifrajhi ko: @jihoon-seo ru: @kirkonru es: @electrocucaracha

Other volunteers: TMPL admins: @rolfedh (needs 1 volunteer) Tech lead: @sftim comms lead: @a-mccarthy

We've estimated that we'd like to have 2 languages with a full set of testers (3 or 4 people) to test workflows as well as get a broader feedback pool (https://github.com/kubernetes/website/issues/45756#issuecomment-2037502746). Right now we only have one team with enough volunteers, pt-br.

We can move ahead with only one "complete" language team and some folks from a different language, but i just wanted to call out that we may have less capacity for testing. If we are able to confirm that all volunteers are still available, I think we can try to move forward.

rolfedh commented 3 months ago

TMPL admins: @rolfedh (needs 1 volunteer)

Unfortunately, due to a change in priorities, I need to step back from volunteering for this role. Anyone else?

krol3 commented 3 months ago

I'm not sure if it's too late, but I'd like to participate as a TLMP tester for Spanish.

Happy to help with the Spanish translation too.

ramrodo commented 3 months ago

@a-mccarthy I would like to help with the Spanish translation too.

Andygol commented 3 months ago

Two weeks since the https://github.com/kubernetes/website/issues/45756#issuecomment-2175007248

sftim commented 3 months ago

progress

Progress is reported on this issue; scroll up for details.

plans to involve more participants from the underrepresented translation teams?

We've put out a call for participation; for a test, it's OK if localization teams don't wish to be involved, or don't have capacity to.

Shubhdeep02 commented 3 months ago

Is someone up for Hindi translation as well?

Andygol commented 1 month ago

Bump the issue to not be frozen

Andygol commented 6 days ago

Bump