Skip to content

Commit a66ab77

Browse files
k8s-ci-robotk8s-ci-robot
authored
Merge pull request #44659 from my-git9/contribute-docs13
[zh-cn] sync contribute/docs.md
2 parents c08484c + 2018a3a commit a66ab77

File tree

1 file changed

+330
-0
lines changed
  • content/zh-cn/docs/contribute

1 file changed

+330
-0
lines changed

‎content/zh-cn/docs/contribute/docs.md

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

0 commit comments

Comments
 (0)