|
1 | 1 | --- |
2 | 2 | content_type: concept |
3 | | -title: Contribute to K8s docs |
4 | | -linktitle: Contribute |
| 3 | +title: Contribute to Kubernetes |
| 4 | +linkTitle: Contribute |
5 | 5 | main_menu: true |
6 | 6 | no_list: true |
7 | 7 | weight: 80 |
8 | 8 | card: |
9 | 9 | name: contribute |
10 | 10 | weight: 10 |
11 | | - title: Start contributing to K8s |
| 11 | + title: Contribute to Kubernetes |
12 | 12 | --- |
13 | 13 |
|
14 | 14 | <!-- overview --> |
15 | 15 |
|
16 | | -*Kubernetes welcomes improvements from all contributors, new and experienced!* |
| 16 | +There are lots of ways to contribute to Kubernetes. You can work on designs for new features, |
| 17 | +you can document the code we already have, you can write for our [blog](/blog). There's more: |
| 18 | +you can implement those new features or fix bugs. You can help people join our contributor |
| 19 | +community, or support existing contributors. |
17 | 20 |
|
18 | | -{{< note >}} |
19 | | -To learn more about contributing to Kubernetes in general, see the |
20 | | -[contributor documentation](https://www.kubernetes.dev/docs/). |
| 21 | +With all these different ways to make a difference to the project, we - Kubernetes - have made |
| 22 | +a dedicated website: https://k8s.dev/. You can go there to learn more about |
| 23 | +contributing to Kubernetes. |
| 24 | + |
| 25 | +If you specifically want to learn about contributing to _this_ documentation, read |
| 26 | +[Contribute to Kubernetes documentation](/docs/contribute/docs/). |
21 | 27 |
|
22 | 28 | You can also read the |
23 | 29 | {{< glossary_tooltip text="CNCF" term_id="cncf" >}} |
24 | 30 | [page](https://contribute.cncf.io/contributors/projects/#kubernetes) |
25 | 31 | about contributing to Kubernetes. |
26 | | -{{< /note >}} |
27 | | - |
28 | | ---- |
29 | | - |
30 | | -This website is maintained by [Kubernetes SIG Docs](/docs/contribute/#get-involved-with-sig-docs). |
31 | | - |
32 | | -Kubernetes documentation contributors: |
33 | | - |
34 | | -- Improve existing content |
35 | | -- Create new content |
36 | | -- Translate the documentation |
37 | | -- Manage and publish the documentation parts of the Kubernetes release cycle |
38 | | - |
39 | | - |
40 | | - |
41 | | -<!-- body --> |
42 | | - |
43 | | -## Getting started |
44 | | - |
45 | | -Anyone can open an issue about documentation, or contribute a change with a |
46 | | -pull request (PR) to the |
47 | | -[`kubernetes/website` GitHub repository](https://github.com/kubernetes/website). |
48 | | -You need to be comfortable with |
49 | | -[git](https://git-scm.com/) and |
50 | | -[GitHub](https://skills.github.com/) |
51 | | -to work effectively in the Kubernetes community. |
52 | | - |
53 | | -To get involved with documentation: |
54 | | - |
55 | | -1. Sign the CNCF [Contributor License Agreement](https://github.com/kubernetes/community/blob/master/CLA.md). |
56 | | -2. Familiarize yourself with the [documentation repository](https://github.com/kubernetes/website) |
57 | | - and the website's [static site generator](https://gohugo.io). |
58 | | -3. Make sure you understand the basic processes for |
59 | | - [opening a pull request](/docs/contribute/new-content/open-a-pr/) and |
60 | | - [reviewing changes](/docs/contribute/review/reviewing-prs/). |
61 | | - |
62 | | -<!-- See https://github.com/kubernetes/website/issues/28808 for live-editor URL to this figure --> |
63 | | -<!-- 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 --> |
64 | | - |
65 | | -{{< mermaid >}} |
66 | | -flowchart TB |
67 | | -subgraph third[Open PR] |
68 | | -direction TB |
69 | | -U[ ] -.- |
70 | | -Q[Improve content] --- N[Create content] |
71 | | -N --- O[Translate docs] |
72 | | -O --- P[Manage/publish docs parts<br>of K8s release cycle] |
73 | | - |
74 | | -end |
75 | | - |
76 | | -subgraph second[Review] |
77 | | -direction TB |
78 | | - T[ ] -.- |
79 | | - D[Look over the<br>kubernetes/website<br>repository] --- E[Check out the<br>Hugo static site<br>generator] |
80 | | - E --- F[Understand basic<br>GitHub commands] |
81 | | - F --- G[Review open PR<br>and change review <br>processes] |
82 | | -end |
83 | | - |
84 | | -subgraph first[Sign up] |
85 | | - direction TB |
86 | | - S[ ] -.- |
87 | | - B[Sign the CNCF<br>Contributor<br>License Agreement] --- C[Join sig-docs<br>Slack channel] |
88 | | - C --- V[Join kubernetes-sig-docs<br>mailing list] |
89 | | - V --- M[Attend weekly<br>sig-docs calls<br>or slack meetings] |
90 | | -end |
91 | | - |
92 | | -A([fa:fa-user New<br>Contributor]) --> first |
93 | | -A --> second |
94 | | -A --> third |
95 | | -A --> H[Ask Questions!!!] |
96 | | - |
97 | | - |
98 | | -classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px; |
99 | | -classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold |
100 | | -classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000 |
101 | | -class A,B,C,D,E,F,G,H,M,Q,N,O,P,V grey |
102 | | -class S,T,U spacewhite |
103 | | -class first,second,third white |
104 | | -{{</ mermaid >}} |
105 | | -Figure 1. Getting started for a new contributor. |
106 | | - |
107 | | -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! |
108 | | - |
109 | | -Some tasks require more trust and more access in the Kubernetes organization. |
110 | | -See [Participating in SIG Docs](/docs/contribute/participate/) for more details about |
111 | | -roles and permissions. |
112 | | - |
113 | | -## Your first contribution |
114 | | - |
115 | | -You can prepare for your first contribution by reviewing several steps beforehand. Figure 2 outlines the steps and the details follow. |
116 | | - |
117 | | -<!-- See https://github.com/kubernetes/website/issues/28808 for live-editor URL to this figure --> |
118 | | -<!-- 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 --> |
119 | | - |
120 | | -{{< mermaid >}} |
121 | | -flowchart LR |
122 | | - subgraph second[First Contribution] |
123 | | - direction TB |
124 | | - S[ ] -.- |
125 | | - G[Review PRs from other<br>K8s members] --> |
126 | | - A[Check kubernetes/website<br>issues list for<br>good first PRs] --> B[Open a PR!!] |
127 | | - end |
128 | | - subgraph first[Suggested Prep] |
129 | | - direction TB |
130 | | - T[ ] -.- |
131 | | - D[Read contribution overview] -->E[Read K8s content<br>and style guides] |
132 | | - E --> F[Learn about Hugo page<br>content types<br>and shortcodes] |
133 | | - end |
134 | | - |
135 | | - |
136 | | - first ----> second |
137 | | - |
138 | | - |
139 | | -classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px; |
140 | | -classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold |
141 | | -classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000 |
142 | | -class A,B,D,E,F,G grey |
143 | | -class S,T spacewhite |
144 | | -class first,second white |
145 | | -{{</ mermaid >}} |
146 | | -Figure 2. Preparation for your first contribution. |
147 | | - |
148 | | -- Read the [Contribution overview](/docs/contribute/new-content/) to |
149 | | - learn about the different ways you can contribute. |
150 | | -- Check [`kubernetes/website` issues list](https://github.com/kubernetes/website/issues/) |
151 | | - for issues that make good entry points. |
152 | | -- [Open a pull request using GitHub](/docs/contribute/new-content/open-a-pr/#changes-using-github) |
153 | | - to existing documentation and learn more about filing issues in GitHub. |
154 | | -- [Review pull requests](/docs/contribute/review/reviewing-prs/) from other |
155 | | - Kubernetes community members for accuracy and language. |
156 | | -- Read the Kubernetes [content](/docs/contribute/style/content-guide/) and |
157 | | - [style guides](/docs/contribute/style/style-guide/) so you can leave informed comments. |
158 | | -- Learn about [page content types](/docs/contribute/style/page-content-types/) |
159 | | - and [Hugo shortcodes](/docs/contribute/style/hugo-shortcodes/). |
160 | | - |
161 | | -## Getting help when contributing |
162 | | - |
163 | | -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. |
164 | | - |
165 | | -## Next steps |
166 | | - |
167 | | -- Learn to [work from a local clone](/docs/contribute/new-content/open-a-pr/#fork-the-repo) |
168 | | - of the repository. |
169 | | -- Document [features in a release](/docs/contribute/new-content/new-features/). |
170 | | -- Participate in [SIG Docs](/docs/contribute/participate/), and become a |
171 | | - [member or reviewer](/docs/contribute/participate/roles-and-responsibilities/). |
172 | | - |
173 | | -- Start or help with a [localization](/docs/contribute/localization/). |
174 | | - |
175 | | -## Get involved with SIG Docs |
176 | | - |
177 | | -[SIG Docs](/docs/contribute/participate/) is the group of contributors who |
178 | | -publish and maintain Kubernetes documentation and the website. Getting |
179 | | -involved with SIG Docs is a great way for Kubernetes contributors (feature |
180 | | -development or otherwise) to have a large impact on the Kubernetes project. |
181 | | - |
182 | | -SIG Docs communicates with different methods: |
183 | | - |
184 | | -- [Join `#sig-docs` on the Kubernetes Slack instance](https://slack.k8s.io/). Make sure to |
185 | | - introduce yourself! |
186 | | -- [Join the `kubernetes-sig-docs` mailing list](https://groups.google.com/forum/#!forum/kubernetes-sig-docs), |
187 | | - where broader discussions take place and official decisions are recorded. |
188 | | -- 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. |
189 | | -- 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. |
190 | | - |
191 | | -## Other ways to contribute |
192 | | - |
193 | | -- Visit the [Kubernetes community site](/community/). Participate on Twitter or Stack Overflow, learn about local Kubernetes meetups and events, and more. |
194 | | -- Read the [contributor cheatsheet](https://www.kubernetes.dev/docs/contributor-cheatsheet/) to get involved with Kubernetes feature development. |
195 | | -- Visit the contributor site to learn more about [Kubernetes Contributors](https://www.kubernetes.dev/) and [additional contributor resources](https://www.kubernetes.dev/resources/). |
196 | | -- Submit a [blog post or case study](/docs/contribute/new-content/blogs-case-studies/). |
197 | | - |
0 commit comments