Skip to content

Commit 139da7d

Browse files
committed
Tidy up: fix bad links in contribution guide
1 parent 1943aaa commit 139da7d

18 files changed

+337
-277
lines changed

content/en/docs/contribute/_index.md

Lines changed: 35 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -28,41 +28,62 @@ Kubernetes documentation welcomes improvements from all contributors, new and ex
2828

2929
## Getting started
3030

31-
Anyone can open an issue about documentation, or contribute a change with a pull request (PR) to the [`kubernetes/website` GitHub repository](https://github.com/kubernetes/website). You need to be comfortable with [git](https://git-scm.com/) and [GitHub](https://lab.github.com/) to operate effectively in the Kubernetes community.
31+
Anyone can open an issue about documentation, or contribute a change with a
32+
pull request (PR) to the
33+
[`kubernetes/website` GitHub repository](https://github.com/kubernetes/website).
34+
You need to be comfortable with
35+
[git](https://git-scm.com/) and
36+
[GitHub](https://lab.github.com/)
37+
to work effectively in the Kubernetes community.
3238

3339
To get involved with documentation:
3440

3541
1. Sign the CNCF [Contributor License Agreement](https://github.com/kubernetes/community/blob/master/CLA.md).
36-
2. Familiarize yourself with the [documentation repository](https://github.com/kubernetes/website) and the website's [static site generator](https://gohugo.io).
37-
3. Make sure you understand the basic processes for [opening a pull request](/docs/contribute/new-content/new-content/) and [reviewing changes](/docs/contribute/review/reviewing-prs/).
42+
1. Familiarize yourself with the [documentation repository](https://github.com/kubernetes/website)
43+
and the website's [static site generator](https://gohugo.io).
44+
1. Make sure you understand the basic processes for
45+
[opening a pull request](/docs/contribute/new-content/open-a-pr/) and
46+
[reviewing changes](/docs/contribute/review/reviewing-prs/).
3847

3948
Some tasks require more trust and more access in the Kubernetes organization.
40-
See [Participating in SIG Docs](/docs/contribute/participating/) for more details about
49+
See [Participating in SIG Docs](/docs/contribute/participate/) for more details about
4150
roles and permissions.
4251

4352
## Your first contribution
4453

45-
- Read the [Contribution overview](/docs/contribute/new-content/overview/) to learn about the different ways you can contribute.
46-
- See [Contribute to kubernetes/website](https://github.com/kubernetes/website/contribute) to find issues that make good entry points.
47-
- [Open a pull request using GitHub](/docs/contribute/new-content/new-content/#changes-using-github) to existing documentation and learn more about filing issues in GitHub.
48-
- [Review pull requests](/docs/contribute/review/reviewing-prs/) from other Kubernetes community members for accuracy and language.
49-
- Read the Kubernetes [content](/docs/contribute/style/content-guide/) and [style guides](/docs/contribute/style/style-guide/) so you can leave informed comments.
50-
- Learn about [page content types](/docs/contribute/style/page-content-types/) and [Hugo shortcodes](/docs/contribute/style/hugo-shortcodes/).
54+
- Read the [Contribution overview](/docs/contribute/new-content/overview/) to
55+
learn about the different ways you can contribute.
56+
- Check [kubernetes/website issues list](/https://github.com/kubernetes/website/issues/)
57+
for issues that make good entry points.
58+
- [Open a pull request using GitHub](/docs/contribute/new-content/open-a-pr/#changes-using-github)
59+
to existing documentation and learn more about filing issues in GitHub.
60+
- [Review pull requests](/docs/contribute/review/reviewing-prs/) from other
61+
Kubernetes community members for accuracy and language.
62+
- Read the Kubernetes [content](/docs/contribute/style/content-guide/) and
63+
[style guides](/docs/contribute/style/style-guide/) so you can leave informed comments.
64+
- Learn about [page content types](/docs/contribute/style/page-content-types/)
65+
and [Hugo shortcodes](/docs/contribute/style/hugo-shortcodes/).
5166

5267
## Next steps
5368

54-
- Learn to [work from a local clone](/docs/contribute/new-content/new-content/#fork-the-repo) of the repository.
69+
- Learn to [work from a local clone](/docs/contribute/new-content/open-a-pr/#fork-the-repo)
70+
of the repository.
5571
- Document [features in a release](/docs/contribute/new-content/new-features/).
56-
- Participate in [SIG Docs](/docs/contribute/participating/), and become a [member or reviewer](/docs/contribute/participating/#roles-and-responsibilities).
72+
- Participate in [SIG Docs](/docs/contribute/participate/), and become a
73+
[member or reviewer](/docs/contribute/participate/roles-and-responsibilities/).
74+
5775
- Start or help with a [localization](/docs/contribute/localization/).
5876

5977
## Get involved with SIG Docs
6078

61-
[SIG Docs](/docs/contribute/participating/) is the group of contributors who publish and maintain Kubernetes documentation and the website. Getting involved with SIG Docs is a great way for Kubernetes contributors (feature development or otherwise) to have a large impact on the Kubernetes project.
79+
[SIG Docs](/docs/contribute/participate/) is the group of contributors who
80+
publish and maintain Kubernetes documentation and the website. Getting
81+
involved with SIG Docs is a great way for Kubernetes contributors (feature
82+
development or otherwise) to have a large impact on the Kubernetes project.
6283

6384
SIG Docs communicates with different methods:
6485

65-
- [Join `#sig-docs` on the Kubernetes Slack instance](http://slack.k8s.io/). Make sure to
86+
- [Join `#sig-docs` on the Kubernetes Slack instance](https://slack.k8s.io/). Make sure to
6687
introduce yourself!
6788
- [Join the `kubernetes-sig-docs` mailing list](https://groups.google.com/forum/#!forum/kubernetes-sig-docs),
6889
where broader discussions take place and official decisions are recorded.

content/en/docs/contribute/advanced.md

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,12 @@ This page assumes that you understand how to
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.
1515

16-
17-
1816
<!-- body -->
1917

2018
## Propose improvements
2119

22-
SIG Docs [members](/docs/contribute/participating/#members) can propose improvements.
20+
SIG Docs [members](/docs/contribute/participate/roles-and-responsibilities/#members)
21+
can propose improvements.
2322

2423
After you've been contributing to the Kubernetes documentation for a while, you
2524
may have ideas for improving the [Style Guide](/docs/contribute/style/style-guide/)
@@ -42,8 +41,8 @@ documentation testing might involve working with sig-testing.
4241

4342
## Coordinate docs for a Kubernetes release
4443

45-
SIG Docs [approvers](/docs/contribute/participating/#approvers) can coordinate
46-
docs for a Kubernetes release.
44+
SIG Docs [approvers](/docs/contribute/participate/roles-and-responsibilities/#approvers)
45+
can coordinate docs for a Kubernetes release.
4746

4847
Each Kubernetes release is coordinated by a team of people participating in the
4948
sig-release Special Interest Group (SIG). Others on the release team for a given
@@ -73,8 +72,8 @@ rotated among SIG Docs approvers.
7372

7473
## Serve as a New Contributor Ambassador
7574

76-
SIG Docs [approvers](/docs/contribute/participating/#approvers) can serve as
77-
New Contributor Ambassadors.
75+
SIG Docs [approvers](/docs/contribute/participate/roles-and-responsibilities/#approvers)
76+
can serve as New Contributor Ambassadors.
7877

7978
New Contributor Ambassadors welcome new contributors to SIG-Docs,
8079
suggest PRs to new contributors, and mentor new contributors through their first
@@ -92,14 +91,14 @@ Current New Contributor Ambassadors are announced at each SIG-Docs meeting, and
9291

9392
## Sponsor a new contributor
9493

95-
SIG Docs [reviewers](/docs/contribute/participating/#reviewers) can sponsor
96-
new contributors.
94+
SIG Docs [reviewers](/docs/contribute/participate/roles-and-responsibilities/#reviewers)
95+
can sponsor new contributors.
9796

9897
After a new contributor has successfully submitted 5 substantive pull requests
9998
to one or more Kubernetes repositories, they are eligible to apply for
100-
[membership](/docs/contribute/participating#members) in the Kubernetes
101-
organization. The contributor's membership needs to be backed by two sponsors
102-
who are already reviewers.
99+
[membership](/docs/contribute/participate/roles-and-responsibilities/#members)
100+
in the Kubernetes organization. The contributor's membership needs to be
101+
backed by two sponsors who are already reviewers.
103102

104103
New docs contributors can request sponsors by asking in the #sig-docs channel
105104
on the [Kubernetes Slack instance](https://kubernetes.slack.com) or on the
@@ -111,7 +110,8 @@ membership in the Kubernetes organization.
111110

112111
## Serve as a SIG Co-chair
113112

114-
SIG Docs [approvers](/docs/contribute/participating/#approvers) can serve a term as a co-chair of SIG Docs.
113+
SIG Docs [approvers](/docs/contribute/participate/roles-and-responsibilities/#approvers)
114+
can serve a term as a co-chair of SIG Docs.
115115

116116
### Prerequisites
117117

@@ -120,7 +120,12 @@ Approvers must meet the following requirements to be a co-chair:
120120
- Have been a SIG Docs approver for at least 6 months
121121
- Have [led a Kubernetes docs release](/docs/contribute/advanced/#coordinate-docs-for-a-kubernetes-release) or shadowed two releases
122122
- Understand SIG Docs workflows and tooling: git, Hugo, localization, blog subproject
123-
- Understand how other Kubernetes SIGs and repositories affect the SIG Docs workflow, including: [teams in k/org](https://github.com/kubernetes/org/blob/master/config/kubernetes/sig-docs/teams.yaml), [process in k/community](https://github.com/kubernetes/community/tree/master/sig-docs), plugins in [k/test-infra](https://github.com/kubernetes/test-infra/), and the role of [SIG Architecture](https://github.com/kubernetes/community/tree/master/sig-architecture).
123+
- Understand how other Kubernetes SIGs and repositories affect the SIG Docs
124+
workflow, including:
125+
[teams in k/org](https://github.com/kubernetes/org/blob/master/config/kubernetes/sig-docs/teams.yaml),
126+
[process in k/community](https://github.com/kubernetes/community/tree/master/sig-docs),
127+
plugins in [k/test-infra](https://github.com/kubernetes/test-infra/), and the role of
128+
[SIG Architecture](https://github.com/kubernetes/community/tree/master/sig-architecture).
124129
- Commit at least 5 hours per week (and often more) to the role for a minimum of 6 months
125130

126131
### Responsibilities
@@ -183,4 +188,4 @@ When you’re ready to start the recording, click Record to Cloud.
183188

184189
When you’re ready to stop recording, click Stop.
185190

186-
The video uploads automatically to YouTube.
191+
The video uploads automatically to YouTube.

content/en/docs/contribute/generate-ref-docs/kubectl.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,21 +15,16 @@ like
1515
[kubectl apply](/docs/reference/generated/kubectl/kubectl-commands#apply) and
1616
[kubectl taint](/docs/reference/generated/kubectl/kubectl-commands#taint).
1717
This topic does not show how to generate the
18-
[kubectl](/docs/reference/generated/kubectl/kubectl/)
18+
[kubectl](/docs/reference/generated/kubectl/kubectl-commands/)
1919
options reference page. For instructions on how to generate the kubectl options
2020
reference page, see
21-
[Generating Reference Pages for Kubernetes Components and Tools](/docs/home/contribute/generated-reference/kubernetes-components/).
21+
[Generating Reference Pages for Kubernetes Components and Tools](/docs/contribute/generate-ref-docs/kubernetes-components/).
2222
{{< /note >}}
2323

24-
25-
2624
## {{% heading "prerequisites" %}}
2725

28-
2926
{{< include "prerequisites-ref-docs.md" >}}
3027

31-
32-
3328
<!-- steps -->
3429

3530
## Setting up the local repositories

content/en/docs/contribute/generate-ref-docs/kubernetes-api.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -194,16 +194,14 @@ The use of `make docker-serve` is deprecated. Please use `make container-serve`
194194
In `<web-base>` run `git add` and `git commit` to commit the change.
195195

196196
Submit your changes as a
197-
[pull request](/docs/contribute/start/) to the
197+
[pull request](/docs/contribute/new-content/open-a-pr/) to the
198198
[kubernetes/website](https://github.com/kubernetes/website) repository.
199199
Monitor your pull request, and respond to reviewer comments as needed. Continue
200200
to monitor your pull request until it has been merged.
201201

202202

203-
204203
## {{% heading "whatsnext" %}}
205204

206-
207205
* [Generating Reference Documentation Quickstart](/docs/contribute/generate-ref-docs/quickstart/)
208206
* [Generating Reference Docs for Kubernetes Components and Tools](/docs/contribute/generate-ref-docs/kubernetes-components/)
209207
* [Generating Reference Documentation for kubectl Commands](/docs/contribute/generate-ref-docs/kubectl/)

content/en/docs/contribute/generate-ref-docs/prerequisites-ref-docs.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,5 @@
1818

1919
- You need to know how to create a pull request to a GitHub repository.
2020
This involves creating your own fork of the repository. For more
21-
information, see [Work from a local clone](/docs/contribute/intermediate/#work_from_a_local_clone).
21+
information, see [Work from a local clone](/docs/contribute/new-content/open-a-pr/#fork-the-repo).
22+

content/en/docs/contribute/generate-ref-docs/quickstart.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,10 @@ This page shows how to use the `update-imported-docs` script to generate
1010
the Kubernetes reference documentation. The script automates
1111
the build setup and generates the reference documentation for a release.
1212

13-
14-
1513
## {{% heading "prerequisites" %}}
1614

17-
1815
{{< include "prerequisites-ref-docs.md" >}}
1916

20-
21-
2217
<!-- steps -->
2318

2419
## Getting the docs repository
@@ -87,7 +82,7 @@ The `update-imported-docs` script performs the following steps:
8782
the sections in the `kubectl` command reference.
8883

8984
When the generated files are in your local clone of the `<web-base>`
90-
repository, you can submit them in a [pull request](/docs/contribute/start/)
85+
repository, you can submit them in a [pull request](/docs/contribute/new-content/open-a-pr/)
9186
to `<web-base>`.
9287

9388
## Configuration file format

content/en/docs/contribute/localization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ Description | URLs
183183
-----|-----
184184
Home | [All heading and subheading URLs](/docs/home/)
185185
Setup | [All heading and subheading URLs](/docs/setup/)
186-
Tutorials | [Kubernetes Basics](/docs/tutorials/kubernetes-basics/), [Hello Minikube](/docs/tutorials/stateless-application/hello-minikube/)
186+
Tutorials | [Kubernetes Basics](/docs/tutorials/kubernetes-basics/), [Hello Minikube](/docs/tutorials/hello-minikube/)
187187
Site strings | [All site strings in a new localized TOML file](https://github.com/kubernetes/website/tree/master/i18n)
188188

189189
Translated documents must reside in their own `content/**/` subdirectory, but otherwise follow the same URL path as the English source. For example, to prepare the [Kubernetes Basics](/docs/tutorials/kubernetes-basics/) tutorial for translation into German, create a subfolder under the `content/de/` folder and copy the English source:

content/en/docs/contribute/new-content/overview.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,12 @@ This section contains information you should know before contributing new conten
2020
- Write Kubernetes documentation in Markdown and build the Kubernetes site using [Hugo](https://gohugo.io/).
2121
- The source is in [GitHub](https://github.com/kubernetes/website). You can find Kubernetes documentation at `/content/en/docs/`. Some of the reference documentation is automatically generated from scripts in the `update-imported-docs/` directory.
2222
- [Page content types](/docs/contribute/style/page-content-types/) describe the presentation of documentation content in Hugo.
23-
- In addition to the standard Hugo shortcodes, we use a number of [custom Hugo shortcodes](/docs/contribute/style/hugo-shortcodes/) in our documentation to control the presentation of content.
24-
- Documentation source is available in multiple languages in `/content/`. Each language has its own folder with a two-letter code determined by the [ISO 639-1 standard](https://www.loc.gov/standards/iso639-2/php/code_list.php). For example, English documentation source is stored in `/content/en/docs/`.
23+
- In addition to the standard Hugo shortcodes, we use a number of
24+
[custom Hugo shortcodes](/docs/contribute/style/hugo-shortcodes/) in our documentation to control the presentation of content.
25+
- Documentation source is available in multiple languages in `/content/`. Each
26+
language has its own folder with a two-letter code determined by the
27+
[ISO 639-1 standard](https://www.loc.gov/standards/iso639-2/php/code_list.php). For
28+
example, English documentation source is stored in `/content/en/docs/`.
2529
- For more information about contributing to documentation in multiple languages or starting a new translation, see [localization](/docs/contribute/localization).
2630

2731
## Before you begin {#before-you-begin}

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

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,18 +20,18 @@ SIG Docs welcomes content and reviews from all contributors. Anyone can open a
2020
pull request (PR), and anyone is welcome to file issues about content or comment
2121
on pull requests in progress.
2222

23-
You can also become a [member](/docs/contribute/participating/roles-and-responsibilities/#members),
24-
[reviewer](/docs/contribute/participating/roles-and-responsibilities/#reviewers), or [approver](/docs/contribute/participating/roles-and-responsibilities/#approvers). These roles require greater
25-
access and entail certain responsibilities for approving and committing changes.
26-
See [community-membership](https://github.com/kubernetes/community/blob/master/community-membership.md)
23+
You can also become a [member](/docs/contribute/participate/roles-and-responsibilities/#members),
24+
[reviewer](/docs/contribute/participate/roles-and-responsibilities/#reviewers), or
25+
[approver](/docs/contribute/participate/roles-and-responsibilities/#approvers).
26+
These roles require greater access and entail certain responsibilities for
27+
approving and committing changes. See
28+
[community-membership](https://github.com/kubernetes/community/blob/master/community-membership.md)
2729
for more information on how membership works within the Kubernetes community.
2830

2931
The rest of this document outlines some unique ways these roles function within
3032
SIG Docs, which is responsible for maintaining one of the most public-facing
3133
aspects of Kubernetes -- the Kubernetes website and documentation.
3234

33-
34-
3535
<!-- body -->
3636

3737
## SIG Docs chairperson
@@ -58,8 +58,9 @@ There are two categories of SIG Docs [teams](https://github.com/orgs/kubernetes/
5858
Each can be referenced with their `@name` in GitHub comments to communicate with
5959
everyone in that group.
6060

61-
Sometimes Prow and GitHub teams overlap without matching exactly. For assignment of issues, pull requests, and to support PR approvals,
62-
the automation uses information from `OWNERS` files.
61+
Sometimes Prow and GitHub teams overlap without matching exactly. For
62+
assignment of issues, pull requests, and to support PR approvals, the
63+
automation uses information from `OWNERS` files.
6364

6465
### OWNERS files and front-matter
6566

@@ -114,6 +115,6 @@ SIG Docs approvers. Here's how it works.
114115

115116
For more information about contributing to the Kubernetes documentation, see:
116117

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

0 commit comments

Comments
 (0)