10BC0 Merge pull request #44686 from my-git9/docs3n · kubernetes/website@9bf997a · GitHub
[go: up one dir, main page]
Skip to content

Commit 9bf997a

Browse files
k8s-ci-robotk8s-ci-robot
authored
Merge pull request #44686 from my-git9/docs3n
improve format for contribute/docs.md pr-wranglers.md
2 parents 8106c6e + a084e30 commit 9bf997a

File tree

2 files changed

+74
-27
lines changed

2 files changed

+74
-27
lines changed

‎content/en/docs/contribute/docs.md‎

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ pull request (PR) to the
3737
You need to be comfortable with
3838
[git](https://git-scm.com/) and
3939
[GitHub](https://skills.github.com/)
40-
to work effectively in the Kubernetes community.
40+
to work effectively in the Kubernetes community.
4141

4242
To get involved with documentation:
4343

@@ -93,15 +93,19 @@ class first,second,third white
9393
{{</ mermaid >}}
9494
Figure 1. Getting started for a new contributor.
9595

96-
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!
96+
Figure 1 outlines a roadmap for new contributors. You can follow some or all of
97+
the steps for `Sign up` and `Review`. Now you are ready to open PRs that achieve
98+
your contribution objectives with some listed under `Open PR`. Again, questions
99+
are always welcome!
97100

98101
Some tasks require more trust and more access in the Kubernetes organization.
99102
See [Participating in SIG Docs](/docs/contribute/participate/) for more details about
100103
roles and permissions.
101104

102105
## Your first contribution
103106

104-
You can prepare for your first contribution by reviewing several steps beforehand. Figure 2 outlines the steps and the details follow.
107+
You can prepare for your first contribution by reviewing several steps beforehand.
108+
Figure 2 outlines the steps and the details follow.
105109

106110
<!-- See https://github.com/kubernetes/website/issues/28808 for live-editor URL to this figure -->
107111
<!-- You can also cut/paste the mermaid code into the live editor at https://mermaid-js.github.io/mermaid-live-editor to play around with it -->
@@ -149,7 +153,13 @@ Figure 2. Preparation for your first contribution.
149153

150154
## Getting help when contributing
151155

152-
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.
156+
Making your first contribution can be overwhelming. The
157+
[New Contributor Ambassadors](https://github.com/kubernetes/website#new-contributor-ambassadors)
158+
are there to walk you through making your first few contributions. You can reach out to them in the
159+
[Kubernetes Slack](https://slack.k8s.io/) preferably in the `#sig-docs` channel. There is also the
160+
[New Contributors Meet and Greet call](https://www.kubernetes.dev/resources/calendar/)
161+
that happens on the first Tuesday of every month. You can interact with the New Contributor Ambassadors
162+
and get your queries resolved here.
153163

154164
## Next steps
155165

@@ -174,13 +184,20 @@ SIG Docs communicates with different methods:
174184
introduce yourself!
175185
- [Join the `kubernetes-sig-docs` mailing list](https://groups.google.com/forum/#!forum/kubernetes-sig-docs),
176186
where broader discussions take place and official decisions are recorded.
177-
- 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.
178-
- Join the SIG Docs async Slack standup meeting on those weeks when the in-person Zoom video meeting does not take pla 8000 ce. Meetings are always announced on `#sig-docs`. You can contribute to any one of the threads up to 24 hours after meeting announcement.
187+
- Join the [SIG Docs video meeting](https://github.com/kubernetes/community/tree/master/sig-docs)
188+
held every two weeks. Meetings are always announced on `#sig-docs` and added to the
189+
[Kubernetes community meetings calendar](https://calendar.google.com/calendar/embed?src=cgnt364vd8s86hr2phapfjc6uk%40group.calendar.google.com&ctz=America/Los_Angeles).
190+
You'll need to download the [Zoom client](https://zoom.us/download) or dial in using a phone.
191+
- Join the SIG Docs async Slack standup meeting on those weeks when the in-person Zoom
192+
video meeting does not take place. Meetings are always announced on `#sig-docs`.
193+
You can contribute to any one of the threads up to 24 hours after meeting announcement.
179194

180195
## Other ways to contribute
181196

182-
- Visit the [Kubernetes community site](/community/). Participate on Twitter or Stack Overflow, learn about local Kubernetes meetups and events, and more.
183-
- Read the [contributor cheatsheet](https://www.kubernetes.dev/docs/contributor-cheatsheet/) to get involved with Kubernetes feature development.
184-
- Visit the contributor site to learn more about [Kubernetes Contributors](https://www.kubernetes.dev/) and [additional contributor resources](https://www.kubernetes.dev/resources/).
197+
- Visit the [Kubernetes community site](/community/). Participate on Twitter or Stack Overflow,
198+
learn about local Kubernetes meetups and events, and more.
199+
- Read the [contributor cheatsheet](https://www.kubernetes.dev/docs/contributor-cheatsheet/)
200+
to get involved with Kubernetes feature development.
201+
- Visit the contributor site to learn more about [Kubernetes Contributors](https://www.kubernetes.dev/)
202+
and [additional contributor resources](https://www.kubernetes.dev/resources/).
185203
- Submit a [blog post or case study](/docs/contribute/new-content/blogs-case-studies/).
186-

‎content/en/docs/contribute/participate/pr-wranglers.md‎

Lines changed: 47 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,27 +6,36 @@ weight: 20
66

77
<!-- overview -->
88

9-
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.
9+
SIG Docs [approvers](/docs/contribute/participate/roles-and-responsibilities/#approvers)
10+
take week-long shifts [managing pull requests](https://github.com/kubernetes/website/wiki/PR-Wranglers)
11+
for the repository.
1012

11-
This section covers the duties of a PR wrangler. For more information on giving good reviews, see [Reviewing changes](/docs/contribute/review/).
13+
This section covers the duties of a PR wrangler. For more information on giving good reviews,
14+
see [Reviewing changes](/docs/contribute/review/).
1215

1316
<!-- body -->
1417

1518
## Duties
1619

1720
Each day in a week-long shift as PR Wrangler:
1821

19-
- 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.
20-
- 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.
22+
- Triage and tag incoming issues daily. See
23+
[Triage and categorize issues](/docs/contribute/review/for-approvers/#triage-and-categorize-issues)
24+
for guidelines on how SIG Docs uses metadata.
25+
- Review [open pull requests](https://github.com/kubernetes/website/pulls) for quality
26+
and adherence to the [Style](/docs/contribute/style/style-guide/) and
27+
[Content](/docs/contribute/style/content-guide/) guides.
2128
- Start with the smallest PRs (`size/XS`) first, and end with the largest (`size/XXL`). Review as many PRs as you can.
2229
- Make sure PR contributors sign the [CLA](https://github.com/kubernetes/community/blob/master/CLA.md).
23-
- Use [this](https://github.com/zparnold/k8s-docs-pr-botherer) script to remind contributors that haven't signed the CLA to do so.
30+
- Use [this](https://github.com/zparnold/k8s-docs-pr-botherer) script to remind contributors
31+
that haven't signed the CLA to do so.
2432
- Provide feedback on changes and ask for technical reviews from members of other SIGs.
2533
- Provide inline suggestions on the PR for the proposed content changes.
2634
- If you need to verify content, comment on the PR and request more details.
2735
- Assign relevant `sig/` label(s).
2836
- If needed, assign reviewers from the `reviewers:` block in the file's front matter.
29-
- You can also tag a [SIG](https://github.com/kubernetes/community/blob/master/sig-list.md) for a review by commenting `@kubernetes/<sig>-pr-reviews` on the PR.
37+
- You can also tag a [SIG](https://github.com/kubernetes/community/blob/master/sig-list.md)
38+
for a review by commenting `@kubernetes/<sig>-pr-reviews` on the PR.
3039
- Use the `/approve` comment to approve a PR for merging. Merge the PR when ready.
3140
- PRs should have a `/lgtm` comment from another member before merging.
3241
- 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
4857
the PR and remind them that they can open it after signing the CLA.
4958
**Do not review PRs whose authors have not signed the CLA!**
5059
- [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):
51-
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.
60+
Lists PRs that need an LGTM from a member. If the PR needs technical review,
61+
loop in one of the reviewers suggested by the bot. If the content needs work,
62+
add suggestions and feedback in-line.
5263
- [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+):
5364
Lists PRs that need an `/approve` comment to merge.
54-
- [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]).
55-
- [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 @<manager's_github-username>`. If the PR is against an old branch, help the author figure out whether it's targeted against the best branch.
65+
- [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):
66+
Lists PRs against the main branch with no clear blockers.
67+
(change "XS" in the size label as you work through the PRs [XS, S, M, L, XL, XXL]).
68+
- [Not against the primary branch](https://github.com/kubernetes/website/pulls?q=is%3Aopen+is%3Apr+label%3Alanguage%2Fen+-base%3Amain):
69+
If the PR is against a `dev-` branch, it's for an upcoming release. Assign the
70+
[docs release manager](https://github.com/kubernetes/sig-release/tree/master/release-team#kubernetes-release-team-roles)
71+
using: `/assign @<manager's_github-username>`. If the PR is against an old branch,
72+
help the author figure out whether it's targeted against the best branch.
5673

5774
### Helpful Prow commands for wranglers
5875

@@ -74,30 +91,43 @@ Reviews and approvals are one tool to keep our PR queue short and current. Anoth
7491
Close PRs where:
7592
- The author hasn't signed the CLA for two weeks.
7693

77-
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.
94+
Authors can reopen the PR after signing the CLA. This is a low-risk way to make
95+
sure nothing gets merged without a signed CLA.
7896

7997
- The author has not responded to comments or feedback in 2 or more weeks.
8098

81-
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.
99+
Don't be afraid to close pull requests. Contributors can easily reopen and resume works in progress.
100+
Often a closure notice is what spurs an author to resume and finish their contribution.
82101

83102
To close a pull request, leave a `/close` comment on the PR.
84103

85104
{{< note >}}
86105

87-
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.
106+
The [`k8s-triage-robot`](https://github.com/k8s-triage-robot) bot marks issues
107+
as stale after 90 days of inactivity. After 30 more days it marks issues as rotten
108+
and closes them. PR wranglers should close issues after 14-30 days of inactivity.
88109

89110
{{< /note >}}
90111

91112
## PR Wrangler shadow program
92113

93-
In late 2021, SIG Docs introduced the PR Wrangler Shadow Program. The program was introduced to help new contributors understand the PR wrangling process.
114+
In late 2021, SIG Docs introduced the PR Wrangler Shadow Program.
115+
The program was introduced to help new contributors understand the PR wrangling process.
94116

95117
### Become a shadow
96118

97-
- 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.
119+
- If you are interested in shadowing as a PR wrangler, please visit the
120+
[PR Wranglers Wiki page](https://github.com/kubernetes/website/wiki/PR-Wranglers)
121+
to see the PR wrangling schedule for this year and sign up.
98122

99-
- 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.
123+
- Kubernetes org members can edit the
124+
[PR Wranglers Wiki page](https://github.com/kubernetes/website/wiki/PR-Wranglers)
125+
and sign up to shadow an existing PR Wrangler for a week.
100126

101-
- 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).
127+
- Others can reach out on the [#sig-docs Slack channel](https://kubernetes.slack.com/messages/sig-docs)
128+
for requesting to shadow an assigned PR Wrangler for a specific week. Feel free to reach out to
129+
Brad Topol (`@bradtopol`) or one of the
130+
[SIG Docs co-chairs/leads](https://github.com/kubernetes/community/tree/master/sig-docs#leadership).
102131

103-
- Once you've signed up to shadow a PR Wrangler, introduce yourself to the PR Wrangler on the [Kubernetes Slack](https://slack.k8s.io).
132+
- Once you've signed up to shadow a PR Wrangler, introduce yourself to the PR Wrangler on the
133+
[Kubernetes Slack](https://slack.k8s.io).

0 commit comments

Comments
 (0)
0