|
1 | 1 | ---
|
2 | 2 | content_type: concept
|
3 |
| -title: 为 K8s 文档出一份力 |
4 |
| -linktitle: 贡献 |
| 3 | +title: 为 Kubernetes 出一份力 |
| 4 | +linkTitle: 贡献 |
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: 开始为 K8s 做贡献 |
| 11 | + title: 开始为 Kubernetes 做贡献 |
12 | 12 | ---
|
13 | 13 | <!--
|
14 | 14 | content_type: concept
|
15 |
| -title: Contribute to K8s docs |
16 |
| -linktitle: Contribute |
| 15 | +title: Contribute to Kubernetes |
| 16 | +linkTitle: Contribute |
17 | 17 | main_menu: true
|
18 | 18 | no_list: true
|
19 | 19 | weight: 80
|
20 | 20 | card:
|
21 | 21 | name: contribute
|
22 | 22 | weight: 10
|
23 |
| - title: Start contributing to K8s |
| 23 | + title: Contribute to Kubernetes |
24 | 24 | -->
|
25 | 25 |
|
26 | 26 | <!-- overview -->
|
27 | 27 |
|
28 | 28 | <!--
|
29 |
| -*Kubernetes welcomes improvements from all contributors, new and experienced!* |
| 29 | +There are lots of ways to contribute to Kubernetes. You can work on designs for new features, |
| 30 | +you can document the code we already have, you can write for our [blog](/blog). There's more: |
| 31 | +you can implement those new features or fix bugs. You can help people join our contributor |
| 32 | +community, or support existing contributors. |
30 | 33 | -->
|
31 |
| -**Kubernetes 欢迎来自所有贡献者的改进,无论你是新人和有经验的贡献者!** |
| 34 | +为 Kubernetes 做出贡献的方法有很多。你可以致力于新特性的设计、记录我们已有的代码、为我们的[博客](/blog)写文章。 |
| 35 | +还有更多:你可以实现这些新特性或修复 Bug、可以帮助人们加入我们的贡献者社区,或支持现有的贡献者。 |
32 | 36 |
|
33 |
| -{{< note >}} |
34 | 37 | <!--
|
35 |
| -To learn more about contributing to Kubernetes in general, see the |
36 |
| -[contributor documentation](https://www.kubernetes.dev/docs/). |
| 38 | +With all these different ways to make a difference to the project, we - Kubernetes - have made |
| 39 | +a dedicated website: https://k8s.dev/. You can go there to learn more about |
| 40 | +contributing to Kubernetes. |
37 | 41 |
|
38 |
| -You can also read the |
39 |
| -{{< glossary_tooltip text="CNCF" term_id="cncf" >}} |
40 |
| -[page](https://contribute.cncf.io/contributors/projects/#kubernetes) |
41 |
| -about contributing to Kubernetes. |
| 42 | +If you specifically want to learn about contributing to _this_ documentation, read |
| 43 | +[Contribute to Kubernetes documentation](/docs/contribute/docs/). |
42 | 44 | -->
|
43 |
| -要了解有关为 Kubernetes 做出贡献的更多信息,请参阅 |
44 |
| -[贡献者文档](https://www.kubernetes.dev/docs/)。 |
| 45 | +通过所有这些不同的方式来改变项目,我们(Kubernetes)制作了一个专门的网站:https://k8s.dev/。 |
| 46 | +你可以去那里了解有关为 Kubernetes 做出贡献的更多信息。 |
45 | 47 |
|
46 |
| -你还可以阅读 |
47 |
| -{{< glossary_tooltip text="CNCF" term_id="cncf" >}} |
48 |
| -关于为 Kubernetes 做贡献的[页面](https://contribute.cncf.io/contributors/projects/#kubernetes)。 |
49 |
| -{{< /note >}} |
50 |
| - |
51 |
| -<!-- |
52 |
| -This website is maintained by [Kubernetes SIG Docs](/docs/contribute/#get-involved-with-sig-docs). |
53 |
| -
|
54 |
| -Kubernetes documentation contributors: |
55 |
| -
|
56 |
| -- Improve existing content |
57 |
| -- Create new content |
58 |
| -- Translate the documentation |
59 |
| -- Manage and publish the documentation parts of the Kubernetes release cycle |
60 |
| ---> |
61 |
| -本网站由 [Kubernetes SIG Docs](/zh-cn/docs/contribute/#get-involved-with-SIG-Docs)(文档特别兴趣小组)维护。 |
62 |
| - |
63 |
| -Kubernetes 文档项目的贡献者: |
64 |
| - |
65 |
| -- 改进现有内容 |
66 |
| -- 创建新内容 |
67 |
| -- 翻译文档 |
68 |
| -- 管理并发布 Kubernetes 周期性发行版的文档 |
69 |
| - |
70 |
| -<!-- body --> |
71 |
| - |
72 |
| -<!-- |
73 |
| -## Getting started |
74 |
| -
|
75 |
| -Anyone can open an issue about documentation, or contribute a change with a |
76 |
| -pull request (PR) to the |
77 |
| -[`kubernetes/website` GitHub repository](https://github.com/kubernetes/website). |
78 |
| -You need to be comfortable with |
79 |
| -[git](https://git-scm.com/) and |
80 |
| -[GitHub](https://lab.github.com/) |
81 |
| -to work effectively in the Kubernetes community. |
82 |
| ---> |
83 |
| -## 入门 {#getting-started} |
84 |
| - |
85 |
| -任何人都可以提出文档方面的问题(issue),或贡献一个变更,用拉取请求(PR)的方式提交到 |
86 |
| -[GitHub 上的 `kubernetes/website` 仓库](https://github.com/kubernetes/website)。 |
87 |
| -当然你需要熟练使用 [git](https://git-scm.com/) 和 [GitHub](https://lab.github.com/) |
88 |
| -才能在 Kubernetes 社区中有效工作。 |
89 |
| - |
90 |
| -<!-- |
91 |
| -To get involved with documentation: |
92 |
| -
|
93 |
| -1. Sign the CNCF [Contributor License Agreement](https://github.com/kubernetes/community/blob/master/CLA.md). |
94 |
| -2. Familiarize yourself with the [documentation repository](https://github.com/kubernetes/website) |
95 |
| - and the website's [static site generator](https://gohugo.io). |
96 |
| -3. Make sure you understand the basic processes for |
97 |
| - [opening a pull request](/docs/contribute/new-content/open-a-pr/) and |
98 |
| - [reviewing changes](/docs/contribute/review/reviewing-prs/). |
99 |
| ---> |
100 |
| -如何参与文档编制: |
101 |
| - |
102 |
| -1. 签署 CNCF 的[贡献者许可协议](https://github.com/kubernetes/community/blob/master/CLA.md)。 |
103 |
| -2. 熟悉[文档仓库](https://github.com/kubernetes/website)和网站的[静态站点生成器](https://gohugo.io)。 |
104 |
| -3. 确保理解[发起 PR](/zh-cn/docs/contribute/new-content/open-a-pr/) |
105 |
| - 和[审查变更](/zh-cn/docs/contribute/review/reviewing-prs/)的基本流程。 |
106 |
| - |
107 |
| -<!-- See https://github.com/kubernetes/website/issues/28808 for live-editor URL to this figure --> |
108 |
| -<!-- 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 --> |
109 |
| - |
110 |
| -{{< mermaid >}} |
111 |
| -flowchart TB |
112 |
| -subgraph third[发起 PR] |
113 |
| -direction TB |
114 |
| -U[ ] -.- |
115 |
| -Q[改进现有内容] --- N[创建新内容] |
116 |
| -N --- O[翻译文档] |
117 |
| -O --- P[管理并发布 K8s<br>周期性发行版的文档] |
118 |
| - |
119 |
| -end |
120 |
| - |
121 |
| -subgraph second[评审] |
122 |
| -direction TB |
123 |
| - T[ ] -.- |
124 |
| - D[仔细查看<br>kubernetes/website<br>仓库] --- E[下载安装 Hugo<br>静态站点<br>生成器] |
125 |
| - E --- F[了解基本的<br>GitHub 命令] |
126 |
| - F --- G[评审待处理的 PR<br>并遵从变更审查<br>流程] |
127 |
| -end |
128 |
| - |
129 |
| -subgraph first[注册] |
130 |
| - direction TB |
131 |
| - S[ ] -.- |
132 |
| - B[签署 CNCF<br>贡献者<br>许可协议] --- C[加入 sig-docs<br>Slack 频道] |
133 |
| - C --- V[加入 kubernetes-sig-docs<br>邮件列表] |
134 |
| - V --- M[参加每周的<br>sig-docs 电话会议<br>或 slack 会议] |
135 |
| -end |
136 |
| - |
137 |
| -A([fa:fa-user 新的<br>贡献者]) --> first |
138 |
| -A --> second |
139 |
| -A --> third |
140 |
| -A --> H[提出问题!!!] |
141 |
| - |
142 |
| - |
143 |
| -classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px; |
144 |
| -classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold |
145 |
| -classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000 |
146 |
| -class A,B,C,D,E,F,G,H,M,Q,N,O,P,V grey |
147 |
| -class S,T,U spacewhite |
148 |
| -class first,second,third white |
149 |
| -{{</ mermaid >}} |
150 |
| - |
151 |
| -<!-- |
152 |
| -Figure 1. Getting started for a new contributor. |
153 |
| -
|
154 |
| -Figure 1 outlines a roadmap for new contributors. You can follow some or |
155 |
| -all of the steps for `Sign up` and `Review`. Now you are ready to open PRs |
156 |
| -that achieve your contribution objectives with some listed under `Open PR`. |
157 |
| -Again, questions are always welcome! |
158 |
| ---> |
159 |
| -图 1. 新手入门指示。 |
160 |
| - |
161 |
| -图 1 概述了新贡献者的路线图。 |
162 |
| -你可以遵从“注册”和“评审”所述的某些或全部步骤。 |
163 |
| -至此,你完成了发起 PR 的准备工作, |
164 |
| -可以通过“发起 PR” 列出的事项实现你的贡献目标。 |
165 |
| -再次重申,欢迎随时提出问题! |
166 |
| - |
167 |
| -<!-- |
168 |
| -Some tasks require more trust and more access in the Kubernetes organization. |
169 |
| -See [Participating in SIG Docs](/docs/contribute/participate/) for more details about |
170 |
| -roles and permissions. |
171 |
| ---> |
172 |
| -有些任务要求 Kubernetes 组织内更高的信任级别和访问权限。 |
173 |
| -阅读[参与 SIG Docs 工作](/zh-cn/docs/contribute/participate/),获取角色和权限的更多细节。 |
174 |
| - |
175 |
| -<!-- |
176 |
| -## Your first contribution |
177 |
| -
|
178 |
| -You can prepare for your first contribution by reviewing several steps beforehand. Figure 2 outlines the steps and the details follow. |
179 |
| ---> |
180 |
| -## 第一次贡献 {#your-first-contribution} |
181 |
| - |
182 |
| -你可以提前查阅几个步骤,来准备你的第一次贡献。 |
183 |
| -图 2 概述了后续的步骤和细节。 |
184 |
| - |
185 |
| -<!-- See https://github.com/kubernetes/website/issues/28808 for live-editor URL to this figure --> |
186 |
| -<!-- 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 --> |
187 |
| - |
188 |
| -{{< mermaid >}} |
189 |
| -flowchart LR |
190 |
| - subgraph second[第一次贡献] |
191 |
| - direction TB |
192 |
| - S[ ] -.- |
193 |
| - G[查阅其他 K8s<br>成员发起的 PR] --> |
194 |
| - A[检索 kubernetes/website<br>问题列表是否有<br>good first 一类的 PR] --> B[发起一个 PR!!] |
195 |
| - end |
196 |
| - subgraph first[建议的准备工作] |
197 |
| - direction TB |
198 |
| - T[ ] -.- |
199 |
| - D[阅读贡献概述] -->E[阅读 K8s 内容<br>和风格指南] |
200 |
| - E --> F[了解 Hugo 页面<br>内容类型<br>和短代码] |
201 |
| - end |
202 |
| - |
203 |
| - |
204 |
| - first ----> second |
205 |
| - |
206 |
| - |
207 |
| -classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px; |
208 |
| -classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold |
209 |
| -classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000 |
210 |
| -class A,B,D,E,F,G grey |
211 |
| -class S,T spacewhite |
212 |
| -class first,second white |
213 |
| -{{</ mermaid >}} |
214 |
| - |
215 |
| -<!-- |
216 |
| -Figure 2. Preparation for your first contribution. |
217 |
| ---> |
218 |
| -图 2. 第一次贡献的准备工作。 |
219 |
| - |
220 |
| -<!-- |
221 |
| -- Read the [Contribution overview](/docs/contribute/new-content/) to |
222 |
| - learn about the different ways you can contribute. |
223 |
| -- Check [`kubernetes/website` issues list](https://github.com/kubernetes/website/issues/) |
224 |
| - for issues that make good entry points. |
225 |
| -- [Open a pull request using GitHub](/docs/contribute/new-content/open-a-pr/#changes-using-github) |
226 |
| - to existing documentation and learn more about filing issues in GitHub. |
227 |
| -- [Review pull requests](/docs/contribute/review/reviewing-prs/) from other |
228 |
| - Kubernetes community members for accuracy and language. |
229 |
| -- Read the Kubernetes [content](/docs/contribute/style/content-guide/) and |
230 |
| - [style guides](/docs/contribute/style/style-guide/) so you can leave informed comments. |
231 |
| -- Learn about [page content types](/docs/contribute/style/page-content-types/) |
232 |
| - and [Hugo shortcodes](/docs/contribute/style/hugo-shortcodes/). |
233 |
| ---> |
234 |
| -- 通读[贡献概述](/zh-cn/docs/contribute/new-content/),了解参与贡献的不同方式。 |
235 |
| -- 查看 [`kubernetes/website` 问题列表](https://github.com/kubernetes/website/issues/), |
236 |
| - 检索最适合作为切入点的问题。 |
237 |
| -- 在现有文档上,[使用 GitHub 提交 PR](/zh-cn/docs/contribute/new-content/open-a-pr/#changes-using-github), |
238 |
| - 掌握在 GitHub 上登记 Issue 的方法。 |
239 |
| -- Kubernetes 社区其他成员会[评审 PR](/zh-cn/docs/contribute/review/reviewing-prs/), |
240 |
| - 以确保文档精准和语言流畅。 |
241 |
| -- 阅读 kubernetes 的[内容指南](/zh-cn/docs/contribute/style/content-guide/)和 |
242 |
| - [风格指南](/zh-cn/docs/contribute/style/style-guide/),以发表有见地的评论。 |
243 |
| -- 了解[页面内容类型](/zh-cn/docs/contribute/style/page-content-types/)和 |
244 |
| - [Hugo 短代码](/zh-cn/docs/contribute/style/hugo-shortcodes/)。 |
245 |
| - |
246 |
| -<!-- |
247 |
| -## Getting help when contributing |
248 |
| -
|
249 |
| -Making your first contribution can be overwhelming. The |
250 |
| -[New Contributor Ambassadors](https://github.com/kubernetes/website#new-contributor-ambassadors) |
251 |
| -are there to walk you through making your first few contributions. |
252 |
| -You can reach out to them in the [Kubernetes Slack](https://slack.k8s.io/) |
253 |
| -preferably in the `#sig-docs` channel. There is also the |
254 |
| -[New Contributors Meet and Greet call](https://www.kubernetes.dev/resources/calendar/) |
255 |
| -that happens on the first Tuesday of every month. You can interact with |
256 |
| -the New Contributor Ambassadors and get your queries resolved here. |
257 |
| ---> |
258 |
| -## 贡献时获取帮助 |
259 |
| - |
260 |
| -做出第一个贡献可能会让人感觉比较困难。 |
261 |
| -[新贡献者大使](https://github.com/kubernetes/website#new-contributor-ambassadors) |
262 |
| -将引导你完成最初的一些贡献。你可以在 [Kubernetes Slack](https://slack.k8s.io/) |
263 |
| -中联系他们,最好是在 `#sig-docs` 频道中。还有每月第一个星期二举行的 |
264 |
| -[新贡献者见面会](https://www.kubernetes.dev/resources/calendar/), |
265 |
| -你可以在此处与新贡献者大使互动并解决你的疑问。 |
266 |
| - |
267 |
| -<!-- |
268 |
| -## Next steps |
269 |
| -
|
270 |
| -- Learn to [work from a local clone](/docs/contribute/new-content/open-a-pr/#fork-the-repo) |
271 |
| - of the repository. |
272 |
| -- Document [features in a release](/docs/contribute/new-content/new-features/). |
273 |
| -- Participate in [SIG Docs](/docs/contribute/participate/), and become a |
274 |
| - [member or reviewer](/docs/contribute/participate/roles-and-responsibilities/). |
275 |
| -
|
276 |
| -- Start or help with a [localization](/docs/contribute/localization/). |
277 |
| ---> |
278 |
| -## 下一步 {#next-teps} |
279 |
| - |
280 |
| -- 学习在仓库的[本地克隆中工作](/zh-cn/docs/contribute/new-content/open-a-pr/#fork-the-repo)。 |
281 |
| -- 为[发行版的特性](/zh-cn/docs/contribute/new-content/new-features/)编写文档。 |
282 |
| -- 加入 [SIG Docs](/zh-cn/docs/contribute/participate/), |
283 |
| - 并成为[成员或评审者](/zh-cn/docs/contribute/participate/roles-and-responsibilities/)。 |
284 |
| -- 开始或帮助[本地化](/zh-cn/docs/contribute/localization/)工作。 |
285 |
| - |
286 |
| -<!-- |
287 |
| -## Get involved with SIG Docs |
288 |
| -
|
289 |
| -[SIG Docs](/docs/contribute/participate/) is the group of contributors who |
290 |
| -publish and maintain Kubernetes documentation and the website. Getting |
291 |
| -involved with SIG Docs is a great way for Kubernetes contributors (feature |
292 |
| -development or otherwise) to have a large impact on the Kubernetes project. |
293 |
| -
|
294 |
| -SIG Docs communicates with different methods: |
295 |
| ---> |
296 |
| -## 参与 SIG Docs 工作 {#get-involved-with-SIG-Docs} |
297 |
| - |
298 |
| -[SIG Docs](/zh-cn/docs/contribute/participate/) 是负责发布、维护 Kubernetes 文档的贡献者团体。 |
299 |
| -参与 SIG Docs 是 Kubernetes 贡献者(开发者和其他人员)对 Kubernetes 项目产生重大影响力的好方式。 |
300 |
| - |
301 |
| -SIG Docs 的几种沟通方式: |
302 |
| - |
303 |
| -<!-- |
304 |
| -- [Join `#sig-docs` on the Kubernetes Slack instance](https://slack.k8s.io/). Make sure to |
305 |
| - introduce yourself! |
306 |
| -- [Join the `kubernetes-sig-docs` mailing list](https://groups.google.com/forum/#!forum/kubernetes-sig-docs), |
307 |
| - where broader discussions take place and official decisions are recorded. |
308 |
| -- 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. |
309 |
| -- 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. |
310 |
| ---> |
311 |
| -- [加入 Kubernetes 在 Slack 上的 `#sig-docs` 频道](https://slack.k8s.io/)。 |
312 |
| - 一定记得自我介绍! |
313 |
| -- [加入 `kubernetes-sig-docs` 邮件列表](https://groups.google.com/forum/#!forum/kubernetes-sig-docs), |
314 |
| - 这里有更广泛的讨论,和官方决策的记录。 |
315 |
| -- 参加每两周召开一次的 [SIG Docs 视频会议](https://github.com/kubernetes/community/tree/master/sig-docs)。 |
316 |
| - 会议总是在 `#sig-docs` 上发出公告,同时添加到 |
317 |
| - [Kubernetes 社区会议日历](https://calendar.google.com/calendar/embed?src=cgnt364vd8s86hr2phapfjc6uk%40group.calendar.google.com&ctz=America/Los_Angeles)。 |
318 |
| - 你需要下载 [Zoom 客户端软件](https://zoom.us/download),或电话拨号接入。 |
319 |
| -- 如果有几周未召开实况 Zoom 视频会议,请参加 SIG Docs 异步 Slack 站会。 |
320 |
| - 会议总是在 `#sig-docs` 上发出公告。 |
321 |
| - 你可以在会议公告后 24 小时内为其中任一议题做贡献。 |
322 |
| - |
323 |
| -<!-- |
324 |
| -## Other ways to contribute |
325 |
| -
|
326 |
| -- Visit the [Kubernetes community site](/community/). Participate on Twitter or Stack Overflow, learn about local Kubernetes meetups and events, and more. |
327 |
| -- Read the [contributor cheatsheet](https://www.kubernetes.dev/docs/contributor-cheatsheet/) to get involved with Kubernetes feature development. |
328 |
| -- Visit the contributor site to learn more about [Kubernetes Contributors](https://www.kubernetes.dev/) and [additional contributor resources](https://www.kubernetes.dev/resources/). |
329 |
| -- Submit a [blog post or case study](/docs/contribute/new-content/blogs-case-studies/). |
330 |
| ---> |
331 |
| -## 其他贡献方式 {#other-ways-to-contribute} |
332 |
| - |
333 |
| -- 访问 [Kubernetes 社区网站](/zh-cn/community/)。 |
334 |
| - 参与 Twitter 或 Stack Overflow,了解当地的 Kubernetes 会议和活动等等。 |
335 |
| -- 阅读[贡献者备忘单](https://github.com/kubernetes/community/tree/master/contributors/guide/contributor-cheatsheet), |
336 |
| - 参与 Kubernetes 功能开发。 |
337 |
| -- 访问贡献者网站,进一步了解有关 [Kubernetes 贡献者](https://www.kubernetes.dev/) |
338 |
| - 和[更多贡献者资源](https://www.kubernetes.dev/resources/)的信息。 |
339 |
| -- 提交一篇[博客文章或案例研究](/zh-cn/docs/contribute/new-content/blogs-case-studies/)。 |
| 48 | +如果你特别想了解如何为**本**文档做出贡献,请阅读[为 Kubernetes 文档做出贡献](/zh-cn/docs/contribute/docs/)。 |
0 commit comments