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

Update Reviewers/Approvers for localized READMEs #47762

Open
Okabe-Junya opened this issue Sep 2, 2024 · 8 comments · May be fixed by #47763
Open

Update Reviewers/Approvers for localized READMEs #47762

Okabe-Junya opened this issue Sep 2, 2024 · 8 comments · May be fixed by #47763
Assignees
Labels
area/localization General issues or PRs related to localization kind/feature Categorizes issue or PR as related to a new feature. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one.

Comments

@Okabe-Junya
Copy link
Member

This is a Feature Request

What would you like to be added

  • Update Reviewers/Approvers for localized READMEs

Why is this needed

k/website repository has localized READMEs, but the ownership of these files belongs tosig-docs-website-owners, not to l10n teams.

website/OWNERS

Lines 3 to 7 in b2c8d81

reviewers:
- sig-docs-website-owners # Defined in OWNERS_ALIASES
approvers:
- sig-docs-website-owners # Defined in OWNERS_ALIASES

This means that when we update a localized README, the PR is assigned to sig-docs-website-owners as reviewers / approvers, not to l10n reviewers. (e.g., #46256)

I think these PRs should be assigned to and approved by l10n teams.

Comments

/area localization

@Okabe-Junya Okabe-Junya added the kind/feature Categorizes issue or PR as related to a new feature. label Sep 2, 2024
@k8s-ci-robot k8s-ci-robot added the area/localization General issues or PRs related to localization label Sep 2, 2024
@k8s-ci-robot
Copy link
Contributor

This issue is currently awaiting triage.

SIG Docs takes a lead on issue triage for this website, but any Kubernetes member can accept issues by applying the triage/accepted label.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Sep 2, 2024
@Okabe-Junya
Copy link
Member Author

/assign

@reylejano
Copy link
Member

cc @seokho-son @a-mccarthy

@seokho-son
Copy link
Member

Hi @Okabe-Junya :)

Thank you for bringing up this issue. To implement this, we need to assign individual OWNERS for each README-xx.md file. However, since we currently utilize directory-based OWNERS, it’s challenging to assign separate l10n OWNERS for the README-xx.md files located at the root path.

My suggestion is to move the README-xx.md files into an internal directory, so that they can be managed by the l10n reviewers/approvers. (Creating new directories is not ideal from an OWNERS file management perspective, so I would prefer to avoid that.)

Perhaps moving them to /data/i18n/xx (i.e., https://github.com/kubernetes/website/tree/main/data/i18n/ja) or /content/xx (i.e., https://github.com/kubernetes/website/tree/main/content/ja) would be a good solution. Then, we can update the links to the localized README files in the root README.md.

What do you think? :)

@Okabe-Junya
Copy link
Member Author

Okabe-Junya commented Sep 4, 2024

Thanks, @seokho-son!

I have already worked on this issue and resolved it by using the "filter" feature of the OWNERS file – there is no need to move the README-*.md files.

An (unofficial) review has already been conducted, and it seems to be working well :)
Any thought? Thanks!

@Okabe-Junya
Copy link
Member Author

However, (though unrelated to this issue) I think it would be a good idea to mov localized READMEs directories.

Just IMO, I'm not a fan of having too many files in the root of the repository – especially if many of those files are irrelevant to most people.

@seokho-son
Copy link
Member

@Okabe-Junya
I agree with your opinion. :)

Just IMO, I'm not a fan of having too many files in the root of the repository – especially if many of those files are irrelevant to most people.

Additionally, even though we now have the "filter" feature for the OWNDERS file, I'm not in favor of managing many filter options within the OWNDERS file either. I believe this could also lead to maintenance issues. Considering this, I would prefer to move the README-xx.md files to other existing directories managed by the l10n teams.

@Okabe-Junya
Copy link
Member Author

Thank you for the good feedback! Your insights are always wonderful and helpful to us, and me!

To make it easier to track, let’s continue the discussion in the PR :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/localization General issues or PRs related to localization kind/feature Categorizes issue or PR as related to a new feature. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants