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/review/reviewing-prs.md
+52-33Lines changed: 52 additions & 33 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,8 @@ weight: 10
7
7
8
8
<!-- overview -->
9
9
10
-
Anyone can review a documentation pull request. Visit the [pull requests](https://github.com/kubernetes/website/pulls) section in the Kubernetes website repository to see open pull requests.
10
+
Anyone can review a documentation pull request. Visit the [pull requests](https://github.com/kubernetes/website/pulls)
11
+
section in the Kubernetes website repository to see open pull requests.
11
12
12
13
Reviewing documentation pull requests is a
13
14
great way to introduce yourself to the Kubernetes community.
@@ -27,7 +28,9 @@ Before reviewing, it's a good idea to:
27
28
28
29
Before you start a review:
29
30
30
-
- Read the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md) and ensure that you abide by it at all times.
31
+
32
+
- Read the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md)
33
+
and ensure that you abide by it at all times.
31
34
- Be polite, considerate, and helpful.
32
35
- Comment on positive aspects of PRs as well as changes.
33
36
- Be empathetic and mindful of how your review may be received.
@@ -36,7 +39,8 @@ Before you start a review:
36
39
37
40
## Review process
38
41
39
-
In general, review pull requests for content and style in English. Figure 1 outlines the steps for the review process. The details for each step follow.
42
+
In general, review pull requests for content and style in English. Figure 1 outlines the steps for
43
+
the review process. The details for each step follow.
40
44
41
45
<!-- See https://github.com/kubernetes/website/issues/28808 for live-editor URL to this figure -->
42
46
<!-- 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 -->
You see a list of every open pull request against the Kubernetes website and
75
-
docs.
76
-
77
-
2. Filter the open PRs using one or all of the following labels:
78
-
-`cncf-cla: yes` (Recommended): PRs submitted by contributors who have not signed the CLA cannot be merged. See [Sign the CLA](/docs/contribute/new-content/overview/#sign-the-cla) for more information.
79
-
-`language/en` (Recommended): Filters for english language PRs only.
80
-
-`size/<size>`: filters for PRs of a certain size. If you're new, start with smaller PRs.
81
-
82
-
Additionally, ensure the PR isn't marked as a work in progress. PRs using the `work in progress` label are not ready for review yet.
83
-
84
-
3. Once you've selected a PR to review, understand the change by:
85
-
- Reading the PR description to understand the changes made, and read any linked issues
86
-
- Reading any comments by other reviewers
87
-
- Clicking the **Files changed** tab to see the files and lines changed
88
-
- Previewing the changes in the Netlify preview build by scrolling to the PR's build check section at the bottom of the **Conversation** tab.
89
-
Here's a screenshot (this shows GitHub's desktop site; if you're reviewing
90
-
on a tablet or smartphone device, the GitHub web UI is slightly different):
91
-
{{< figure src="/images/docs/github_netlify_deploy_preview.png" alt="GitHub pull request details including link to Netlify preview" >}}
92
-
To open the preview, click on the **Details** link of the **deploy/netlify** line in the list of checks.
93
-
94
-
4. Go to the **Files changed** tab to start your review.
95
-
1. Click on the `+` symbol beside the line you want to comment on.
96
-
2. Fill in any comments you have about the line and click either **Add single comment** (if you have only one comment to make) or **Start a review** (if you have multiple comments to make).
97
-
3. When finished, click **Review changes** at the top of the page. Here, you can add
76
+
1. Go to [https://github.com/kubernetes/website/pulls](https://github.com/kubernetes/website/pulls).
77
+
You see a list of every open pull request against the Kubernetes website and docs.
78
+
79
+
2. Filter the open PRs using one or all of the following labels:
80
+
81
+
-`cncf-cla: yes` (Recommended): PRs submitted by contributors who have not signed the CLA
82
+
cannot be merged. See [Sign the CLA](/docs/contribute/new-content/#sign-the-cla)
83
+
for more information.
84
+
-`language/en` (Recommended): Filters for english language PRs only.
85
+
-`size/<size>`: filters for PRs of a certain size. If you're new, start with smaller PRs.
86
+
87
+
Additionally, ensure the PR isn't marked as a work in progress. PRs using the `work in
88
+
progress` label are not ready for review yet.
89
+
90
+
3. Once you've selected a PR to review, understand the change by:
91
+
92
+
- Reading the PR description to understand the changes made, and read any linked issues
93
+
- Reading any comments by other reviewers
94
+
- Clicking the **Files changed** tab to see the files and lines changed
95
+
- Previewing the changes in the Netlify preview build by scrolling to the PR's build check
96
+
section at the bottom of the **Conversation** tab.
97
+
Here's a screenshot (this shows GitHub's desktop site; if you're reviewing
98
+
on a tablet or smartphone device, the GitHub web UI is slightly different):
99
+
{{< figure src="/images/docs/github_netlify_deploy_preview.png" alt="GitHub pull request details including link to Netlify preview" >}}
100
+
To open the preview, click on the **Details** link of the **deploy/netlify** line in the
101
+
list of checks.
102
+
103
+
4. Go to the **Files changed** tab to start your review.
104
+
105
+
1. Click on the `+` symbol beside the line you want to comment on.
106
+
1. Fill in any comments you have about the line and click either **Add single comment** (if you
107
+
have only one comment to make) or **Start a review** (if you have multiple comments to make).
108
+
1. When finished, click **Review changes** at the top of the page. Here, you can add
98
109
a summary of your review (and leave some positive comments for the contributor!),
99
110
approve the PR, comment or request changes as needed. New contributors should always
100
111
choose **Comment**.
@@ -119,14 +130,22 @@ When reviewing, use the following as a starting point.
119
130
120
131
### Website
121
132
122
-
- Did this PR change or remove a page title, slug/alias or anchor link? If so, are there broken links as a result of this PR? Is there another option, like changing the page title without changing the slug?
133
+
- Did this PR change or remove a page title, slug/alias or anchor link? If so, are there broken
134
+
links as a result of this PR? Is there another option, like changing the page title without
135
+
changing the slug?
136
+
123
137
- Does the PR introduce a new page? If so:
124
-
- Is the page using the right [page content type](/docs/contribute/style/page-content-types/) and associated Hugo shortcodes?
138
+
139
+
- Is the page using the right [page content type](/docs/contribute/style/page-content-types/)
140
+
and associated Hugo shortcodes?
125
141
- Does the page appear correctly in the section's side navigation (or at all)?
126
142
- Should the page appear on the [Docs Home](/docs/home/) listing?
127
-
- Do the changes show up in the Netlify preview? Be particularly vigilant about lists, code blocks, tables, notes and images.
143
+
144
+
- Do the changes show up in the Netlify preview? Be particularly vigilant about lists, code
145
+
blocks, tables, notes and images.
128
146
129
147
### Other
130
148
131
-
For small issues with a PR, like typos or whitespace, prefix your comments with `nit:`. This lets the author know the issue is non-critical.
149
+
For small issues with a PR, like typos or whitespace, prefix your comments with `nit:`.
150
+
This lets the author know the issue is non-critical.
[Check whether Dockershim deprecation affects you](/docs/tasks/administer-cluster/migrating-from-dockershim/check-if-dockershim-deprecation-affects-you/) to understand how this removal might
40
-
affect you. To learn about migrating from using dockershim, see
for details about upgrading your cluster using `kubeadm`.
509
-
* Learn about advanced `kubeadm` usage in the [kubeadm reference documentation](/docs/reference/setup-tools/kubeadm/kubeadm)
511
+
* Learn about advanced `kubeadm` usage in the [kubeadm reference documentation](/docs/reference/setup-tools/kubeadm/)
510
512
* Learn more about Kubernetes [concepts](/docs/concepts/) and [`kubectl`](/docs/reference/kubectl/).
511
513
* See the [Cluster Networking](/docs/concepts/cluster-administration/networking/) page for a bigger list
512
514
of Pod network add-ons.
@@ -613,4 +615,6 @@ supports your chosen platform.
613
615
614
616
## Troubleshooting {#troubleshooting}
615
617
616
-
If you are running into difficulties with kubeadm, please consult our [troubleshooting docs](/docs/setup/production-environment/tools/kubeadm/troubleshooting-kubeadm/).
618
+
If you are running into difficulties with kubeadm, please consult our
0 commit comments