You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/docs/contribute/docs.md
+27-10Lines changed: 27 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,7 +37,7 @@ pull request (PR) to the
37
37
You need to be comfortable with
38
38
[git](https://git-scm.com/) and
39
39
[GitHub](https://skills.github.com/)
40
-
to work effectively in the Kubernetes community.
40
+
to work effectively in the Kubernetes community.
41
41
42
42
To get involved with documentation:
43
43
@@ -93,15 +93,19 @@ class first,second,third white
93
93
{{</ mermaid >}}
94
94
Figure 1. Getting started for a new contributor.
95
95
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!
97
100
98
101
Some tasks require more trust and more access in the Kubernetes organization.
99
102
See [Participating in SIG Docs](/docs/contribute/participate/) for more details about
100
103
roles and permissions.
101
104
102
105
## Your first contribution
103
106
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.
105
109
106
110
<!-- See https://github.com/kubernetes/website/issues/28808 for live-editor URL to this figure -->
107
111
<!-- 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.
149
153
150
154
## Getting help when contributing
151
155
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
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.
153
163
154
164
## Next steps
155
165
@@ -174,13 +184,20 @@ SIG Docs communicates with different methods:
174
184
introduce yourself!
175
185
-[Join the `kubernetes-sig-docs` mailing list](https://groups.google.com/forum/#!forum/kubernetes-sig-docs),
176
186
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 place. 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.
179
194
180
195
## Other ways to contribute
181
196
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/).
185
203
- Submit a [blog post or case study](/docs/contribute/new-content/blogs-case-studies/).
Copy file name to clipboardExpand all lines: content/en/docs/contribute/participate/pr-wranglers.md
+47-17Lines changed: 47 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,27 +6,36 @@ weight: 20
6
6
7
7
<!-- overview -->
8
8
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.
10
12
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/).
12
15
13
16
<!-- body -->
14
17
15
18
## Duties
16
19
17
20
Each day in a week-long shift as PR Wrangler:
18
21
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
- Start with the smallest PRs (`size/XS`) first, and end with the largest (`size/XXL`). Review as many PRs as you can.
22
29
- 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.
24
32
- Provide feedback on changes and ask for technical reviews from members of other SIGs.
25
33
- Provide inline suggestions on the PR for the proposed content changes.
26
34
- If you need to verify content, comment on the PR and request more details.
27
35
- Assign relevant `sig/` label(s).
28
36
- 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.
30
39
- Use the `/approve` comment to approve a PR for merging. Merge the PR when ready.
31
40
- PRs should have a `/lgtm` comment from another member before merging.
32
41
- 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
48
57
the PR and remind them that they can open it after signing the CLA.
49
58
**Do not review PRs whose authors have not signed the CLA!**
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,
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.
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.
56
73
57
74
### Helpful Prow commands for wranglers
58
75
@@ -74,30 +91,43 @@ Reviews and approvals are one tool to keep our PR queue short and current. Anoth
74
91
Close PRs where:
75
92
- The author hasn't signed the CLA for two weeks.
76
93
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.
78
96
79
97
- The author has not responded to comments or feedback in 2 or more weeks.
80
98
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.
82
101
83
102
To close a pull request, leave a `/close` comment on the PR.
84
103
85
104
{{< note >}}
86
105
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.
88
109
89
110
{{< /note >}}
90
111
91
112
## PR Wrangler shadow program
92
113
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.
94
116
95
117
### Become a shadow
96
118
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.
98
122
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.
100
126
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
0 commit comments