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

Create docs-zh-approvers etc #4465

Closed
3 tasks done
Tracked by #4467
chalin opened this issue May 10, 2024 · 16 comments · Fixed by #4522 or #4584
Closed
3 tasks done
Tracked by #4467

Create docs-zh-approvers etc #4465

chalin opened this issue May 10, 2024 · 16 comments · Fixed by #4522 or #4584
Assignees
Labels
Milestone

Comments

@chalin
Copy link
Contributor

chalin commented May 10, 2024

@open-telemetry/docs-maintainers : given that we'll soon have Chinese language content, shall we create an OTel org-level team, say, docs-zh-approvers. That would make official who the custodians of those pages are, and make it possible to set CODEOWNERS, etc.

Tasks

Reference

@chalin chalin added e0-minutes Effort: < 60 min p1-high p2-medium i18n internationalization admin labels May 10, 2024
@svrnm
Copy link
Member

svrnm commented May 10, 2024

Yes, we need that. There are docs-cn-approvers and docs-cn-maintaines already, who own https://github.com/open-telemetry/docs-cn. Not sure why there are no groups for docs-ja repo.

@chalin
Copy link
Contributor Author

chalin commented May 10, 2024

Since cn isn't an official language code, it might be better to use zh so that we have a consistent pattern for all languages that the website might eventually support.

@svrnm
Copy link
Member

svrnm commented May 10, 2024

As a point of reference, kubernetes has https://kubernetes.io/zh-cn/

@chalin
Copy link
Contributor Author

chalin commented May 10, 2024

Right, they use a region-specific language code (zh-cn) rather than the more general zh. We need to consider if we want to follow suite.

I guess that in that sense @open-telemetry/docs-cn-maintainers and @open-telemetry/docs-cn-approvers might be file.

But, depending on the outcome / feedback regarding #2402 (comment), we might not need to do anything more.

@windsonsea
Copy link
Member

IMO, all of these language code for Chinese are easy to understand. One concern is to keep consistency in the entire OTel org. We can pick one and use it throughly:

  • zh
  • zh-cn
  • cn

@svrnm
Copy link
Member

svrnm commented May 13, 2024

Thanks @windsonsea

A few more data points from CNCF

@chalin
Copy link
Contributor Author

chalin commented May 13, 2024

I'd vote for zh, like GH. Whilezh-cn is an official language code, AFAIK, cn is not.

Edit: ok, to be clear, because this issue is referring to GH groups, for the group name, it probably doesn't matter much (as to whether it's an official language code or not): so we could "reuse" the existing groups, ... maybe?

As for the language code for the OTel website: the language code is currently set to zh. Shall we stick to that or follow CNCF sibling sites?

@chalin chalin mentioned this issue May 13, 2024
41 tasks
@chalin
Copy link
Contributor Author

chalin commented May 13, 2024

@svrnm - how about creating a label for Chinese page changes -- such as, say, lang:zh?

@windsonsea
Copy link
Member

Yes, it would be helpful to add a label to clearly identify zh translations. Additionally, we should set the CODEOWNERs to docs-zh-approvers and assign PRs with the lang:zh label to this team.

If possible, I would greatly appreciate becoming a member of the docs-zh-approvers team. 😄

@svrnm
Copy link
Member

svrnm commented May 14, 2024

label lang:zh created, I also provided a PR (#4480) to get it automatically applied on changes to content/zh

@svrnm
Copy link
Member

svrnm commented May 14, 2024

See open-telemetry/community#2107

@chalin chalin added this to the 24Q2 milestone May 14, 2024
@chalin chalin changed the title Consider creating docs-zh-approvers or similar org-level team Create docs-zh-approvers etc May 15, 2024
@svrnm svrnm linked a pull request May 22, 2024 that will close this issue
@chalin
Copy link
Contributor Author

chalin commented May 27, 2024

Reopening until we answer the following question:

Originally posted by @chalin in #4522 (comment)

I'd like to suggest that content/zh/ also have @open-telemetry/docs-approvers, if only initially, as we iron out the wrinkles in the process. @open-telemetry/docs-approvers can always RSLGTM for PRs that are pure content, but as we ramp up there are likely to be "structural" / Hugo / Docsy / tooling related issues.

@chalin chalin reopened this May 27, 2024
@windsonsea
Copy link
Member

Could we grant zh-approvers the permission to merge only the content/zh docs? This would apply to PRs labeled with lang:zh.

@svrnm
Copy link
Member

svrnm commented Jun 3, 2024

Could we grant zh-approvers the permission to merge only the content/zh docs? This would apply to PRs labeled with lang:zh.

Tbh, I am not exactly sure if/how we can configure the repository to make this possible.

@chalin
Copy link
Contributor Author

chalin commented Jun 3, 2024

I'd keep it simple, and for the next couple of months, just add @open-telemetry/docs-maintainers over the zh folder.

@chalin
Copy link
Contributor Author

chalin commented Jun 3, 2024

Here's my proposal for now:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
3 participants