Skip to content

Commit 2b99761

Browse files
authored
Merge pull request #19576 from celestehorgan/temporary-branch-2
Restructure and consolidate information in Contribute section
2 parents fafe933 + f0cded0 commit 2b99761

20 files changed

+1272
-1486
lines changed

content/en/docs/contribute/_index.md

Lines changed: 48 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -4,59 +4,74 @@ title: Contribute to Kubernetes docs
44
linktitle: Contribute
55
main_menu: true
66
weight: 80
7+
card:
8+
name: contribute
9+
weight: 10
10+
title: Start contributing
711
---
812

913
{{% capture overview %}}
1014

11-
If you would like to help contribute to the Kubernetes documentation or website,
12-
we're happy to have your help! Anyone can contribute, whether you're new to the
13-
project or you've been around a long time, and whether you self-identify as a
14-
developer, an end user, or someone who just can't stand seeing typos.
15+
This website is maintained by [Kubernetes SIG Docs](/docs/contribute/#get-involved-with-sig-docs).
16+
17+
Kubernetes documentation contributors:
18+
19+
- Improve existing content
20+
- Create new content
21+
- Translate the documentation
22+
- Manage and publish the documentation parts of the Kubernetes release cycle
23+
24+
Kubernetes documentation welcomes improvements from all contributors, new and experienced!
1525

1626
{{% /capture %}}
1727

1828
{{% capture body %}}
1929

20-
## Getting Started
30+
## Getting started
2131

22-
Anyone can open an issue describing problems or desired improvements with documentation, or contribute a change with a pull request (PR).
23-
Some tasks require more trust and need more access in the Kubernetes organization.
24-
See [Participating in SIG Docs](/docs/contribute/participating/) for more details about
25-
of roles and permissions.
26-
27-
Kubernetes documentation resides in a GitHub repository. While we welcome
28-
contributions from anyone, you do need basic comfort with git and GitHub to
29-
operate effectively in the Kubernetes community.
32+
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.
3033

3134
To get involved with documentation:
3235

3336
1. Sign the CNCF [Contributor License Agreement](https://github.com/kubernetes/community/blob/master/CLA.md).
3437
2. Familiarize yourself with the [documentation repository](https://github.com/kubernetes/website) and the website's [static site generator](https://gohugo.io).
35-
3. Make sure you understand the basic processes for [improving content](https://kubernetes.io/docs/contribute/start/#improve-existing-content) and [reviewing changes](https://kubernetes.io/docs/contribute/start/#review-docs-pull-requests).
38+
3. Make sure you understand the basic processes for [opening a pull request](/docs/contribute/new-content/open-a-pr/) and [reviewing changes](/docs/contribute/review/reviewing-prs/).
3639

37-
## Contributions best practices
40+
Some tasks require more trust and more access in the Kubernetes organization.
41+
See [Participating in SIG Docs](/docs/contribute/participating/) for more details about
42+
roles and permissions.
3843

39-
- Do write clear and meaningful GIT commit messages.
40-
- Make sure to include _Github Special Keywords_ which references the issue and automatically closes the issue when PR is merged.
41-
- When you make a small change to a PR like fixing a typo, any style change, or changing grammar. Make sure you squash your commits so that you dont get a large number of commits for a relatively small change.
42-
- Make sure you include a nice PR description depicting the code you have changes, why to change a following piece of code and ensuring there is sufficient information for the reviewer to understand your PR.
43-
- Additional Readings :
44-
- [chris.beams.io/posts/git-commit/](https://chris.beams.io/posts/git-commit/)
45-
- [github.com/blog/1506-closing-issues-via-pull-requests ](https://github.com/blog/1506-closing-issues-via-pull-requests )
46-
- [davidwalsh.name/squash-commits-git ](https://davidwalsh.name/squash-commits-git )
44+
## Your first contribution
4745

48-
## Other ways to contribute
46+
- Read the [Contribution overview](/docs/contribute/new-content/overview/) to learn about the different ways you can contribute.
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 how to [use page templates](/docs/contribute/style/page-templates/) and [Hugo shortcodes](/docs/contribute/style/hugo-shortcodes/) to make bigger changes.
4951

50-
- To contribute to the Kubernetes community through online forums like Twitter or Stack Overflow, or learn about local meetups and Kubernetes events, visit the [Kubernetes community site](/community/).
51-
- To contribute to feature development, read the [contributor cheatsheet](https://github.com/kubernetes/community/tree/master/contributors/guide/contributor-cheatsheet) to get started.
52+
## Next steps
5253

53-
{{% /capture %}}
54+
- Learn to [work from a local clone](/docs/contribute/new-content/open-a-pr/#fork-the-repo) of the repository.
55+
- 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).
57+
- Start or help with a [localization](/docs/contribute/localization/).
5458

55-
{{% capture whatsnext %}}
59+
## Get involved with SIG Docs
5660

57-
- For more information about the basics of contributing to documentation, read [Start contributing](/docs/contribute/start/).
58-
- Follow the [Kubernetes documentation style guide](/docs/contribute/style/style-guide/) when proposing changes.
59-
- For more information about SIG Docs, read [Participating in SIG Docs](/docs/contribute/participating/).
60-
- For more information about localizing Kubernetes docs, read [Localizing Kubernetes documentation](/docs/contribute/localization/).
61+
[SIG Docs](/docs/contribute/participating/) is the group of contributors who publish and maintain Kubernetes documentation and the webwsite. 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.
6162

62-
{{% /capture %}}
63+
SIG Docs communicates with different methods:
64+
65+
- [Join `#sig-docs` on the Kubernetes Slack instance](http://slack.k8s.io/). Make sure to
66+
introduce yourself!
67+
- [Join the `kubernetes-sig-docs` mailing list](https://groups.google.com/forum/#!forum/kubernetes-sig-docs),
68+
where broader discussions take place and official decisions are recorded.
69+
- Join the [weekly SIG Docs video meeting](https://github.com/kubernetes/community/tree/master/sig-docs). 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.
70+
71+
## Other ways to contribute
72+
73+
- Visit the [Kubernetes community site](/community/). Participate on Twitter or Stack Overflow, learn about local Kubernetes meetups and events, and more.
74+
- Read the [contributor cheatsheet](https://github.com/kubernetes/community/tree/master/contributors/guide/contributor-cheatsheet) to get involved with Kubernetes feature development.
75+
- Submit a [blog post or case study](/docs/contribute/new-content/blogs-case-studies/).
76+
77+
{{% /capture %}}

content/en/docs/contribute/advanced.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22
title: Advanced contributing
33
slug: advanced
44
content_template: templates/concept
5-
weight: 30
5+
weight: 98
66
---
77

88
{{% capture overview %}}
99

10-
This page assumes that you've read and mastered the
11-
[Start contributing](/docs/contribute/start/) and
12-
[Intermediate contributing](/docs/contribute/intermediate/) topics and are ready
10+
This page assumes that you understand how to
11+
[contribute to new content](/docs/contribute/new-content/overview) and
12+
[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.
1515

@@ -19,7 +19,7 @@ client and other tools for some of these tasks.
1919

2020
## Be the PR Wrangler for a week
2121

22-
SIG Docs [approvers](/docs/contribute/participating/#approvers) take regular turns as the PR wrangler for the repository and are added to the [PR Wrangler rotation scheduler](https://github.com/kubernetes/website/wiki/PR-Wranglers#2019-schedule-q1q2) for weekly rotations.
22+
SIG Docs [approvers](/docs/contribute/participating/#approvers) take week-long turns [wrangling PRs](https://github.com/kubernetes/website/wiki/PR-Wranglers) for the repository.
2323

2424
The PR wrangler’s duties include:
2525

@@ -37,9 +37,9 @@ The PR wrangler’s duties include:
3737
- Assign `Docs Review` and `Tech Review` labels to indicate the PR's review status.
3838
- Assign`Needs Doc Review` or `Needs Tech Review` for PRs that haven't yet been reviewed.
3939
- Assign `Doc Review: Open Issues` or `Tech Review: Open Issues` for PRs that have been reviewed and require further input or action before merging.
40-
- Assign `/lgtm` and `/approve` labels to PRs that can be merged.
40+
- Assign `/lgtm` and `/approve` labels to PRs that can be merged.
4141
- Merge PRs when they are ready, or close PRs that shouldn’t be accepted.
42-
- Triage and tag incoming issues daily. See [Intermediate contributing](/docs/contribute/intermediate/) for guidelines on how SIG Docs uses metadata.
42+
- 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.
4343

4444
### Helpful GitHub queries for wranglers
4545

@@ -60,9 +60,9 @@ reviewed is usually small. These queries specifically exclude localization PRs,
6060

6161
### When to close Pull Requests
6262

63-
Reviews and approvals are one tool to keep our PR queue short and current. Another tool is closure.
63+
Reviews and approvals are one tool to keep our PR queue short and current. Another tool is closure.
6464

65-
- Close any PR where the CLA hasn’t been signed for two weeks.
65+
- Close any PR where the CLA hasn’t been signed for two weeks.
6666
PR authors can reopen the PR after signing the CLA, so this is a low-risk way to make sure nothing gets merged without a signed CLA.
6767

6868
- Close any PR where the author has not responded to comments or feedback in 2 or more weeks.
@@ -82,7 +82,7 @@ An automated service, [`fejta-bot`](https://github.com/fejta-bot) automatically
8282
SIG Docs [members](/docs/contribute/participating/#members) can propose improvements.
8383

8484
After you've been contributing to the Kubernetes documentation for a while, you
85-
may have ideas for improvement to the [Style Guide](/docs/contribute/style/style-guide/)
85+
may have ideas for improving the [Style Guide](/docs/contribute/style/style-guide/)
8686
, the [Content Guide](/docs/contribute/style/content-guide/), the toolchain used to build
8787
the documentation, the website style, the processes for reviewing and merging
8888
pull requests, or other aspects of the documentation. For maximum transparency,
@@ -134,21 +134,21 @@ rotated among SIG Docs approvers.
134134
## Serve as a New Contributor Ambassador
135135

136136
SIG Docs [approvers](/docs/contribute/participating/#approvers) can serve as
137-
New Contributor Ambassadors.
137+
New Contributor Ambassadors.
138138

139-
New Contributor Ambassadors work together to welcome new contributors to SIG-Docs,
139+
New Contributor Ambassadors welcome new contributors to SIG-Docs,
140140
suggest PRs to new contributors, and mentor new contributors through their first
141-
few PR submissions.
141+
few PR submissions.
142142

143-
Responsibilities for New Contributor Ambassadors include:
143+
Responsibilities for New Contributor Ambassadors include:
144144

145-
- Being available on the [Kubernetes #sig-docs channel](https://kubernetes.slack.com) to answer questions from new contributors.
146-
- Working with PR wranglers to identify good first issues for new contributors.
147-
- Mentoring new contributors through their first few PRs to the docs repo.
145+
- Monitoring the [#sig-docs Slack channel](https://kubernetes.slack.com) for questions from new contributors.
146+
- Working with PR wranglers to identify good first issues for new contributors.
147+
- Mentoring new contributors through their first few PRs to the docs repo.
148148
- Helping new contributors create the more complex PRs they need to become Kubernetes members.
149-
- [Sponsoring contributors](/docs/contribute/advanced/#sponsor-a-new-contributor) on their path to becoming Kubernetes members.
149+
- [Sponsoring contributors](/docs/contribute/advanced/#sponsor-a-new-contributor) on their path to becoming Kubernetes members.
150150

151-
Current New Contributor Ambassadors are announced at each SIG-Docs meeting, and in the [Kubernetes #sig-docs channel](https://kubernetes.slack.com).
151+
Current New Contributor Ambassadors are announced at each SIG-Docs meeting, and in the [Kubernetes #sig-docs channel](https://kubernetes.slack.com).
152152

153153
## Sponsor a new contributor
154154

@@ -180,12 +180,12 @@ Approvers must meet the following requirements to be a co-chair:
180180
- Have been a SIG Docs approver for at least 6 months
181181
- Have [led a Kubernetes docs release](/docs/contribute/advanced/#coordinate-docs-for-a-kubernetes-release) or shadowed two releases
182182
- Understand SIG Docs workflows and tooling: git, Hugo, localization, blog subproject
183-
- 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).
183+
- 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).
184184
- Commit at least 5 hours per week (and often more) to the role for a minimum of 6 months
185185

186186
### Responsibilities
187187

188-
The role of co-chair is primarily one of service: co-chairs handle process and policy, schedule and run meetings, schedule PR wranglers, and generally do the things that no one else wants to do in order to build contributor capacity.
188+
The role of co-chair is one of service: co-chairs build contributor capacity, handle process and policy, schedule and run meetings, schedule PR wranglers, advocate for docs in the Kubernetes community, make sure that docs succeed in Kubernetes release cycles, and keep SIG Docs focused on effective priorities.
189189

190190
Responsibilities include:
191191

@@ -228,7 +228,7 @@ For weekly meetings, copypaste the previous week's notes into the "Past meetings
228228

229229
**Honor folks' time**:
230230

231-
- Begin and end meetings punctually
231+
Begin and end meetings on time.
232232

233233
**Use Zoom effectively**:
234234

@@ -240,9 +240,9 @@ For weekly meetings, copypaste the previous week's notes into the "Past meetings
240240
### Recording meetings on Zoom
241241

242242
When you’re ready to start the recording, click Record to Cloud.
243-
243+
244244
When you’re ready to stop recording, click Stop.
245245

246246
The video uploads automatically to YouTube.
247247

248-
{{% /capture %}}
248+
{{% /capture %}}

0 commit comments

Comments
 (0)