Skip to content

Commit 78249f3

Browse files
authored
Merge pull request #34378 from tengqm/fix-links-2
Fix links in some pages (2)
2 parents 013085c + 9b5e2ae commit 78249f3

File tree

7 files changed

+66
-43
lines changed

7 files changed

+66
-43
lines changed

content/en/docs/contribute/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ class first,second white
145145
{{</ mermaid >}}
146146
Figure 2. Preparation for your first contribution.
147147

148-
- Read the [Contribution overview](/docs/contribute/new-content/overview/) to
148+
- Read the [Contribution overview](/docs/contribute/new-content/) to
149149
learn about the different ways you can contribute.
150150
- Check [`kubernetes/website` issues list](https://github.com/kubernetes/website/issues/)
151151
for issues that make good entry points.

content/en/docs/contribute/advanced.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ weight: 98
88
<!-- overview -->
99

1010
This page assumes that you understand how to
11-
[contribute to new content](/docs/contribute/new-content/overview) and
11+
[contribute to new content](/docs/contribute/new-content/) and
1212
[review others' work](/docs/contribute/review/reviewing-prs/), and are ready
1313
to learn about more ways to contribute. You need to use the Git command line
1414
client and other tools for some of these tasks.

content/en/docs/contribute/participate/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,6 @@ SIG Docs approvers. Here's how it works.
115115

116116
For more information about contributing to the Kubernetes documentation, see:
117117

118-
- [Contributing new content](/docs/contribute/new-content/overview/)
118+
- [Contributing new content](/docs/contribute/new-content/)
119119
- [Reviewing content](/docs/contribute/review/reviewing-prs)
120120
- [Documentation style guide](/docs/contribute/style/)

content/en/docs/contribute/participate/roles-and-responsibilities.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Anyone can:
3232
- Suggest improvements on [Slack](https://slack.k8s.io/) or the
3333
[SIG docs mailing list](https://groups.google.com/forum/#!forum/kubernetes-sig-docs).
3434

35-
After [signing the CLA](/docs/contribute/new-content/overview/#sign-the-cla), anyone can also:
35+
After [signing the CLA](https://github.com/kubernetes/community/blob/master/CLA.md), anyone can also:
3636

3737
- Open a pull request to improve existing content, add new content, or write a blog post or case study
3838
- Create diagrams, graphics assets, and embeddable screencasts and videos

content/en/docs/contribute/review/reviewing-prs.md

Lines changed: 52 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ weight: 10
77

88
<!-- overview -->
99

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.
1112

1213
Reviewing documentation pull requests is a
1314
great way to introduce yourself to the Kubernetes community.
@@ -27,7 +28,9 @@ Before reviewing, it's a good idea to:
2728

2829
Before you start a review:
2930

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.
3134
- Be polite, considerate, and helpful.
3235
- Comment on positive aspects of PRs as well as changes.
3336
- Be empathetic and mindful of how your review may be received.
@@ -36,7 +39,8 @@ Before you start a review:
3639

3740
## Review process
3841

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.
4044

4145
<!-- See https://github.com/kubernetes/website/issues/28808 for live-editor URL to this figure -->
4246
<!-- 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 -->
@@ -69,32 +73,39 @@ class third,fourth white
6973

7074
Figure 1. Review process steps.
7175

72-
1. Go to
73-
[https://github.com/kubernetes/website/pulls](https://github.com/kubernetes/website/pulls).
74-
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
98109
a summary of your review (and leave some positive comments for the contributor!),
99110
approve the PR, comment or request changes as needed. New contributors should always
100111
choose **Comment**.
@@ -119,14 +130,22 @@ When reviewing, use the following as a starting point.
119130

120131
### Website
121132

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+
123137
- 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?
125141
- Does the page appear correctly in the section's side navigation (or at all)?
126142
- 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.
128146

129147
### Other
130148

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.
132151

content/en/docs/setup/production-environment/container-runtimes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ part of Kubernetes (this removal was
3636
[announced](/blog/2020/12/08/kubernetes-1-20-release-announcement/#dockershim-deprecation)
3737
as part of the v1.20 release).
3838
You can read
39-
[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
39+
[Check whether Dockershim removal affects you](/docs/tasks/administer-cluster/migrating-from-dockershim/check-if-dockershim-removal-affects-you/)
40+
to understand how this removal might affect you. To learn about migrating from using dockershim, see
4141
[Migrating from dockershim](/docs/tasks/administer-cluster/migrating-from-dockershim/).
4242

4343
If you are running a version of Kubernetes other than v{{< skew currentVersion >}},

content/en/docs/setup/production-environment/tools/kubeadm/create-cluster-kubeadm.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,8 @@ to not download the default container images which are hosted at `k8s.gcr.io`.
9191

9292
Kubeadm has commands that can help you pre-pull the required images
9393
when creating a cluster without an internet connection on its nodes.
94-
See [Running kubeadm without an internet connection](/docs/reference/setup-tools/kubeadm/kubeadm-init#without-internet-connection) for more details.
94+
See [Running kubeadm without an internet connection](/docs/reference/setup-tools/kubeadm/kubeadm-init#without-internet-connection)
95+
for more details.
9596

9697
Kubeadm allows you to use a custom image repository for the required images.
9798
See [Using custom images](/docs/reference/setup-tools/kubeadm/kubeadm-init#custom-images)
@@ -365,7 +366,8 @@ The output is similar to this:
365366
5didvk.d09sbcov8ph2amjw
366367
```
367368

368-
If you don't have the value of `--discovery-token-ca-cert-hash`, you can get it by running the following command chain on the control-plane node:
369+
If you don't have the value of `--discovery-token-ca-cert-hash`, you can get it by running the
370+
following command chain on the control-plane node:
369371

370372
```bash
371373
openssl x509 -pubkey -in /etc/kubernetes/pki/ca.crt | openssl rsa -pubin -outform der 2>/dev/null | \
@@ -506,7 +508,7 @@ options.
506508
* Verify that your cluster is running properly with [Sonobuoy](https://github.com/heptio/sonobuoy)
507509
* <a id="lifecycle" />See [Upgrading kubeadm clusters](/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade/)
508510
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/)
510512
* Learn more about Kubernetes [concepts](/docs/concepts/) and [`kubectl`](/docs/reference/kubectl/).
511513
* See the [Cluster Networking](/docs/concepts/cluster-administration/networking/) page for a bigger list
512514
of Pod network add-ons.
@@ -613,4 +615,6 @@ supports your chosen platform.
613615

614616
## Troubleshooting {#troubleshooting}
615617

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
619+
[troubleshooting docs](/docs/setup/production-environment/tools/kubeadm/troubleshooting-kubeadm/).
620+

0 commit comments

Comments
 (0)