diff --git a/content/en/docs/contribute/docs.md b/content/en/docs/contribute/docs.md index 1f29cd5e85a74..3e43be61925d7 100644 --- a/content/en/docs/contribute/docs.md +++ b/content/en/docs/contribute/docs.md @@ -37,7 +37,7 @@ pull request (PR) to the You need to be comfortable with [git](https://git-scm.com/) and [GitHub](https://skills.github.com/) -to work effectively in the Kubernetes community. +to work effectively in the Kubernetes community. To get involved with documentation: @@ -93,7 +93,10 @@ class first,second,third white {{}} Figure 1. Getting started for a new contributor. -Figure 1 outlines a roadmap for new contributors. You can follow some or all of the steps for `Sign up` and `Review`. Now you are ready to open PRs that achieve your contribution objectives with some listed under `Open PR`. Again, questions are always welcome! +Figure 1 outlines a roadmap for new contributors. You can follow some or all of +the steps for `Sign up` and `Review`. Now you are ready to open PRs that achieve +your contribution objectives with some listed under `Open PR`. Again, questions +are always welcome! Some tasks require more trust and more access in the Kubernetes organization. See [Participating in SIG Docs](/docs/contribute/participate/) for more details about @@ -101,7 +104,8 @@ roles and permissions. ## Your first contribution -You can prepare for your first contribution by reviewing several steps beforehand. Figure 2 outlines the steps and the details follow. +You can prepare for your first contribution by reviewing several steps beforehand. +Figure 2 outlines the steps and the details follow. @@ -149,7 +153,13 @@ Figure 2. Preparation for your first contribution. ## Getting help when contributing -Making your first contribution can be overwhelming. The [New Contributor Ambassadors](https://github.com/kubernetes/website#new-contributor-ambassadors) are there to walk you through making your first few contributions. You can reach out to them in the [Kubernetes Slack](https://slack.k8s.io/) preferably in the `#sig-docs` channel. There is also the [New Contributors Meet and Greet call](https://www.kubernetes.dev/resources/calendar/) that happens on the first Tuesday of every month. You can interact with the New Contributor Ambassadors and get your queries resolved here. +Making your first contribution can be overwhelming. The +[New Contributor Ambassadors](https://github.com/kubernetes/website#new-contributor-ambassadors) +are there to walk you through making your first few contributions. You can reach out to them in the +[Kubernetes Slack](https://slack.k8s.io/) preferably in the `#sig-docs` channel. There is also the +[New Contributors Meet and Greet call](https://www.kubernetes.dev/resources/calendar/) +that happens on the first Tuesday of every month. You can interact with the New Contributor Ambassadors +and get your queries resolved here. ## Next steps @@ -174,13 +184,20 @@ SIG Docs communicates with different methods: introduce yourself! - [Join the `kubernetes-sig-docs` mailing list](https://groups.google.com/forum/#!forum/kubernetes-sig-docs), where broader discussions take place and official decisions are recorded. -- Join the [SIG Docs video meeting](https://github.com/kubernetes/community/tree/master/sig-docs) held every two weeks. Meetings are always announced on `#sig-docs` and added to the [Kubernetes community meetings calendar](https://calendar.google.com/calendar/embed?src=cgnt364vd8s86hr2phapfjc6uk%40group.calendar.google.com&ctz=America/Los_Angeles). You'll need to download the [Zoom client](https://zoom.us/download) or dial in using a phone. -- Join the SIG Docs async Slack standup meeting on those weeks when the in-person Zoom video meeting does not take place. Meetings are always announced on `#sig-docs`. You can contribute to any one of the threads up to 24 hours after meeting announcement. +- Join the [SIG Docs video meeting](https://github.com/kubernetes/community/tree/master/sig-docs) + held every two weeks. Meetings are always announced on `#sig-docs` and added to the + [Kubernetes community meetings calendar](https://calendar.google.com/calendar/embed?src=cgnt364vd8s86hr2phapfjc6uk%40group.calendar.google.com&ctz=America/Los_Angeles). + You'll need to download the [Zoom client](https://zoom.us/download) or dial in using a phone. +- Join the SIG Docs async Slack standup meeting on those weeks when the in-person Zoom + video meeting does not take place. Meetings are always announced on `#sig-docs`. + You can contribute to any one of the threads up to 24 hours after meeting announcement. ## Other ways to contribute -- Visit the [Kubernetes community site](/community/). Participate on Twitter or Stack Overflow, learn about local Kubernetes meetups and events, and more. -- Read the [contributor cheatsheet](https://www.kubernetes.dev/docs/contributor-cheatsheet/) to get involved with Kubernetes feature development. -- Visit the contributor site to learn more about [Kubernetes Contributors](https://www.kubernetes.dev/) and [additional contributor resources](https://www.kubernetes.dev/resources/). +- Visit the [Kubernetes community site](/community/). Participate on Twitter or Stack Overflow, + learn about local Kubernetes meetups and events, and more. +- Read the [contributor cheatsheet](https://www.kubernetes.dev/docs/contributor-cheatsheet/) + to get involved with Kubernetes feature development. +- Visit the contributor site to learn more about [Kubernetes Contributors](https://www.kubernetes.dev/) + and [additional contributor resources](https://www.kubernetes.dev/resources/). - Submit a [blog post or case study](/docs/contribute/new-content/blogs-case-studies/). - diff --git a/content/en/docs/contribute/participate/pr-wranglers.md b/content/en/docs/contribute/participate/pr-wranglers.md index ee553c64d68c8..cc00de9ce10da 100644 --- a/content/en/docs/contribute/participate/pr-wranglers.md +++ b/content/en/docs/contribute/participate/pr-wranglers.md @@ -6,9 +6,12 @@ weight: 20 -SIG Docs [approvers](/docs/contribute/participate/roles-and-responsibilities/#approvers) take week-long shifts [managing pull requests](https://github.com/kubernetes/website/wiki/PR-Wranglers) for the repository. +SIG Docs [approvers](/docs/contribute/participate/roles-and-responsibilities/#approvers) +take week-long shifts [managing pull requests](https://github.com/kubernetes/website/wiki/PR-Wranglers) +for the repository. -This section covers the duties of a PR wrangler. For more information on giving good reviews, see [Reviewing changes](/docs/contribute/review/). +This section covers the duties of a PR wrangler. For more information on giving good reviews, +see [Reviewing changes](/docs/contribute/review/). @@ -16,17 +19,23 @@ This section covers the duties of a PR wrangler. For more information on giving Each day in a week-long shift as PR Wrangler: -- Triage and tag incoming issues daily. See [Triage and categorize issues](/docs/contribute/review/for-approvers/#triage-and-categorize-issues) for guidelines on how SIG Docs uses metadata. -- Review [open pull requests](https://github.com/kubernetes/website/pulls) for quality and adherence to the [Style](/docs/contribute/style/style-guide/) and [Content](/docs/contribute/style/content-guide/) guides. +- Triage and tag incoming issues daily. See + [Triage and categorize issues](/docs/contribute/review/for-approvers/#triage-and-categorize-issues) + for guidelines on how SIG Docs uses metadata. +- Review [open pull requests](https://github.com/kubernetes/website/pulls) for quality + and adherence to the [Style](/docs/contribute/style/style-guide/) and + [Content](/docs/contribute/style/content-guide/) guides. - Start with the smallest PRs (`size/XS`) first, and end with the largest (`size/XXL`). Review as many PRs as you can. - Make sure PR contributors sign the [CLA](https://github.com/kubernetes/community/blob/master/CLA.md). - - Use [this](https://github.com/zparnold/k8s-docs-pr-botherer) script to remind contributors that haven't signed the CLA to do so. + - Use [this](https://github.com/zparnold/k8s-docs-pr-botherer) script to remind contributors + that haven't signed the CLA to do so. - Provide feedback on changes and ask for technical reviews from members of other SIGs. - Provide inline suggestions on the PR for the proposed content changes. - If you need to verify content, comment on the PR and request more details. - Assign relevant `sig/` label(s). - If needed, assign reviewers from the `reviewers:` block in the file's front matter. - - You can also tag a [SIG](https://github.com/kubernetes/community/blob/master/sig-list.md) for a review by commenting `@kubernetes/-pr-reviews` on the PR. + - You can also tag a [SIG](https://github.com/kubernetes/community/blob/master/sig-list.md) + for a review by commenting `@kubernetes/-pr-reviews` on the PR. - Use the `/approve` comment to approve a PR for merging. Merge the PR when ready. - PRs should have a `/lgtm` comment from another member before merging. - Consider accepting technically accurate content that doesn't meet the @@ -48,11 +57,19 @@ These queries exclude localization PRs. All queries are against the main branch the PR and remind them that they can open it after signing the CLA. **Do not review PRs whose authors have not signed the CLA!** - [Needs LGTM](https://github.com/kubernetes/website/pulls?q=is%3Aopen+is%3Apr+-label%3A%22cncf-cla%3A+no%22+-label%3Ado-not-merge%2Fwork-in-progress+-label%3Ado-not-merge%2Fhold+label%3Alanguage%2Fen+-label%3Algtm): - Lists PRs that need an LGTM from a member. If the PR needs technical review, loop in one of the reviewers suggested by the bot. If the content needs work, add suggestions and feedback in-line. + Lists PRs that need an LGTM from a member. If the PR needs technical review, + loop in one of the reviewers suggested by the bot. If the content needs work, + add suggestions and feedback in-line. - [Has LGTM, needs docs approval](https://github.com/kubernetes/website/pulls?q=is%3Aopen+is%3Apr+-label%3Ado-not-merge%2Fwork-in-progress+-label%3Ado-not-merge%2Fhold+label%3Alanguage%2Fen+label%3Algtm+): Lists PRs that need an `/approve` comment to merge. -- [Quick Wins](https://github.com/kubernetes/website/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aopen+base%3Amain+-label%3A%22do-not-merge%2Fwork-in-progress%22+-label%3A%22do-not-merge%2Fhold%22+label%3A%22cncf-cla%3A+yes%22+label%3A%22size%2FXS%22+label%3A%22language%2Fen%22): Lists PRs against the main branch with no clear blockers. (change "XS" in the size label as you work through the PRs [XS, S, M, L, XL, XXL]). -- [Not against the primary branch](https://github.com/kubernetes/website/pulls?q=is%3Aopen+is%3Apr+label%3Alanguage%2Fen+-base%3Amain): If the PR is against a `dev-` branch, it's for an upcoming release. Assign the [docs release manager](https://github.com/kubernetes/sig-release/tree/master/release-team#kubernetes-release-team-roles) using: `/assign @`. If the PR is against an old branch, help the author figure out whether it's targeted against the best branch. +- [Quick Wins](https://github.com/kubernetes/website/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aopen+base%3Amain+-label%3A%22do-not-merge%2Fwork-in-progress%22+-label%3A%22do-not-merge%2Fhold%22+label%3A%22cncf-cla%3A+yes%22+label%3A%22size%2FXS%22+label%3A%22language%2Fen%22): + Lists PRs against the main branch with no clear blockers. + (change "XS" in the size label as you work through the PRs [XS, S, M, L, XL, XXL]). +- [Not against the primary branch](https://github.com/kubernetes/website/pulls?q=is%3Aopen+is%3Apr+label%3Alanguage%2Fen+-base%3Amain): + If the PR is against a `dev-` branch, it's for an upcoming release. Assign the + [docs release manager](https://github.com/kubernetes/sig-release/tree/master/release-team#kubernetes-release-team-roles) + using: `/assign @`. If the PR is against an old branch, + help the author figure out whether it's targeted against the best branch. ### Helpful Prow commands for wranglers @@ -74,30 +91,43 @@ Reviews and approvals are one tool to keep our PR queue short and current. Anoth Close PRs where: - The author hasn't signed the CLA for two weeks. - Authors can reopen the PR after signing the CLA. This is a low-risk way to make sure nothing gets merged without a signed CLA. + Authors can reopen the PR after signing the CLA. This is a low-risk way to make + sure nothing gets merged without a signed CLA. - The author has not responded to comments or feedback in 2 or more weeks. -Don't be afraid to close pull requests. Contributors can easily reopen and resume works in progress. Often a closure notice is what spurs an author to resume and finish their contribution. +Don't be afraid to close pull requests. Contributors can easily reopen and resume works in progress. +Often a closure notice is what spurs an author to resume and finish their contribution. To close a pull request, leave a `/close` comment on the PR. {{< note >}} -The [`k8s-triage-robot`](https://github.com/k8s-triage-robot) bot marks issues as stale after 90 days of inactivity. After 30 more days it marks issues as rotten and closes them. PR wranglers should close issues after 14-30 days of inactivity. +The [`k8s-triage-robot`](https://github.com/k8s-triage-robot) bot marks issues +as stale after 90 days of inactivity. After 30 more days it marks issues as rotten +and closes them. PR wranglers should close issues after 14-30 days of inactivity. {{< /note >}} ## PR Wrangler shadow program -In late 2021, SIG Docs introduced the PR Wrangler Shadow Program. The program was introduced to help new contributors understand the PR wrangling process. +In late 2021, SIG Docs introduced the PR Wrangler Shadow Program. +The program was introduced to help new contributors understand the PR wrangling process. ### Become a shadow -- If you are interested in shadowing as a PR wrangler, please visit the [PR Wranglers Wiki page](https://github.com/kubernetes/website/wiki/PR-Wranglers) to see the PR wrangling schedule for this year and sign up. +- If you are interested in shadowing as a PR wrangler, please visit the + [PR Wranglers Wiki page](https://github.com/kubernetes/website/wiki/PR-Wranglers) + to see the PR wrangling schedule for this year and sign up. -- Kubernetes org members can edit the [PR Wranglers Wiki page](https://github.com/kubernetes/website/wiki/PR-Wranglers) and sign up to shadow an existing PR Wrangler for a week. +- Kubernetes org members can edit the + [PR Wranglers Wiki page](https://github.com/kubernetes/website/wiki/PR-Wranglers) + and sign up to shadow an existing PR Wrangler for a week. -- Others can reach out on the [#sig-docs Slack channel](https://kubernetes.slack.com/messages/sig-docs) for requesting to shadow an assigned PR Wrangler for a specific week. Feel free to reach out to Brad Topol (`@bradtopol`) or one of the [SIG Docs co-chairs/leads](https://github.com/kubernetes/community/tree/master/sig-docs#leadership). +- Others can reach out on the [#sig-docs Slack channel](https://kubernetes.slack.com/messages/sig-docs) + for requesting to shadow an assigned PR Wrangler for a specific week. Feel free to reach out to + Brad Topol (`@bradtopol`) or one of the + [SIG Docs co-chairs/leads](https://github.com/kubernetes/community/tree/master/sig-docs#leadership). -- Once you've signed up to shadow a PR Wrangler, introduce yourself to the PR Wrangler on the [Kubernetes Slack](https://slack.k8s.io). +- Once you've signed up to shadow a PR Wrangler, introduce yourself to the PR Wrangler on the + [Kubernetes Slack](https://slack.k8s.io).