Skip to content

Commit dbc9257

Browse files
committed
[zh] updated two files in content/zh/docs/contribute/
1 parent c2ff409 commit dbc9257

File tree

2 files changed

+252
-100
lines changed

2 files changed

+252
-100
lines changed

content/zh/docs/contribute/_index.md

Lines changed: 145 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ weight: 80
88
card:
99
name: contribute
1010
weight: 10
11-
title: 开始贡献
11+
title: 开始为 Kubernetes 做贡献
1212
---
1313
<!--
1414
---
@@ -21,7 +21,7 @@ weight: 80
2121
card:
2222
name: contribute
2323
weight: 10
24-
title: Start contributing
24+
title: Start contributing to K8s
2525
---
2626
-->
2727

@@ -40,8 +40,9 @@ To learn more about contributing to Kubernetes in general, see the
4040
-->
4141
{{< note >}}
4242
要了解有关为 Kubernetes 做出贡献的更多信息,请参阅
43-
[贡献者文档](https://www.kubernetes.dev/docs/).
43+
[贡献者文档](https://www.kubernetes.dev/docs/)
4444
{{< /note >}}
45+
4546
<!--
4647
This website is maintained by [Kubernetes SIG Docs](/docs/contribute/#get-involved-with-sig-docs).
4748
@@ -51,21 +52,16 @@ Kubernetes documentation contributors:
5152
- Create new content
5253
- Translate the documentation
5354
- Manage and publish the documentation parts of the Kubernetes release cycle
54-
55-
Kubernetes documentation welcomes improvements from all contributors, new and experienced!
5655
-->
56+
本网站由 [Kubernetes SIG(特别兴趣小组)Docs](/zh/docs/contribute/#get-involved-with-SIG-Docs) 维护。
5757

58-
本网站由 [Kubernetes SIG(特别兴趣小组) Docs](/zh/docs/contribute/#get-involved-with-SIG-Docs) 维护。
59-
60-
Kubernetes 文档项目的贡献者:
58+
Kubernetes 文档项目的贡献者:
6159

6260
- 改进现有内容
6361
- 创建新内容
6462
- 翻译文档
6563
- 管理并发布 Kubernetes 周期性发行版的文档
6664

67-
Kubernetes 文档欢迎来自各方贡献者的改进,无论新手还是高手!
68-
6965
<!-- body -->
7066

7167
<!--
@@ -78,42 +74,140 @@ You need to be comfortable with
7874
[git](https://git-scm.com/) and
7975
[GitHub](https://lab.github.com/)
8076
to work effectively in the Kubernetes community.
81-
8277
-->
8378
## 入门 {#getting-started}
8479

8580
任何人都可以提出文档方面的问题(issue),或贡献一个变更,用拉取请求(PR)的方式提交到
8681
[GitHub 上的 `kubernetes/website` 仓库](https://github.com/kubernetes/website)
8782
当然你需要熟练使用 [git](https://git-scm.com/)[GitHub](https://lab.github.com/) 才能在 Kubernetes 社区中有效工作。
83+
8884
<!--
8985
To get involved with documentation:
9086
9187
1. Sign the CNCF [Contributor License Agreement](https://github.com/kubernetes/community/blob/master/CLA.md).
92-
1. Familiarize yourself with the [documentation repository](https://github.com/kubernetes/website)
88+
2. Familiarize yourself with the [documentation repository](https://github.com/kubernetes/website)
9389
and the website's [static site generator](https://gohugo.io).
94-
1. Make sure you understand the basic processes for
90+
3. Make sure you understand the basic processes for
9591
[opening a pull request](/docs/contribute/new-content/open-a-pr/) and
9692
[reviewing changes](/docs/contribute/review/reviewing-prs/).
93+
-->
94+
如何参与文档编制:
95+
96+
1. 签署 CNCF 的[贡献者许可协议](https://github.com/kubernetes/community/blob/master/CLA.md)
97+
2. 熟悉[文档仓库](https://github.com/kubernetes/website)和网站的[静态站点生成器](https://gohugo.io)
98+
3. 确保理解[发起 PR](/zh/docs/contribute/new-content/open-a-pr/)[审查变更](/zh/docs/contribute/review/reviewing-prs/)的基本流程。
99+
100+
<!-- See https://github.com/kubernetes/website/issues/28808 for live-editor URL to this figure -->
101+
<!-- 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 -->
102+
103+
{{< mermaid >}}
104+
flowchart TB
105+
subgraph third[发起 PR]
106+
direction TB
107+
U[ ] -.-
108+
Q[改进现有内容] --- N[创建新内容]
109+
N --- O[翻译文档]
110+
O --- P[管理并发布 K8s<br>周期性发行版的文档]
111+
112+
end
113+
114+
subgraph second[评审]
115+
direction TB
116+
T[ ] -.-
117+
D[仔细查看<br>K8s/website<br>仓库] --- E[下载安装 Hugo<br>静态站点<br>生成器]
118+
E --- F[了解基本的<br>GitHub 命令]
119+
F --- G[评审待处理的 PR<br>并遵从变更审查<br>流程]
120+
end
121+
122+
subgraph first[注册]
123+
direction TB
124+
S[ ] -.-
125+
B[签署 CNCF<br>贡献者<br>许可协议] --- C[加入 sig-docs<br>Slack 频道]
126+
C --- V[加入 kubernetes-sig-docs<br>邮件列表]
127+
V --- M[参加每周的<br>sig-docs 电话会议<br>或 slack 会议]
128+
end
129+
130+
A([fa:fa-user 新的<br>贡献者]) --> first
131+
A --> second
132+
A --> third
133+
A --> H[提出问题!!!]
134+
135+
136+
classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px;
137+
classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold
138+
classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000
139+
class A,B,C,D,E,F,G,H,M,Q,N,O,P,V grey
140+
class S,T,U spacewhite
141+
class first,second,third white
142+
{{</ mermaid >}}
143+
144+
<!--
145+
Figure 1. Getting started for a new contributor.
97146
147+
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!
148+
-->
149+
图 1. 新手入门指示。
150+
151+
图 1 概述了新贡献者的路线图。
152+
你可以遵从`注册``评审`所述的某些或全部步骤。
153+
至此,你完成了发起 PR 的准备工作,
154+
可以通过`发起 PR`列出的事项实现你的贡献目标。
155+
再次重申,欢迎随时提出问题!
156+
157+
<!--
98158
Some tasks require more trust and more access in the Kubernetes organization.
99159
See [Participating in SIG Docs](/docs/contribute/participate/) for more details about
100160
roles and permissions.
101161
-->
102-
如何参与文档编制:
103-
104-
1. 签署 CNCF 的[贡献者许可协议](https://github.com/kubernetes/community/blob/master/CLA.md)
105-
2. 熟悉[文档仓库](https://github.com/kubernetes/website)
106-
和网站的[静态站点生成器](https://gohugo.io)
107-
3. 确保理解
108-
[发起 PR](/zh/docs/contribute/new-content/open-a-pr/)
109-
[审查变更](/zh/docs/contribute/review/reviewing-prs/)的基本流程。
110-
111162
有些任务要求 Kubernetes 组织内更高的信任级别和访问权限。
112163
阅读[参与 SIG Docs 工作](/zh/docs/contribute/participate/) ,获取角色和权限的更多细节。
113164

114-
<!--
165+
<!--
115166
## Your first contribution
116167
168+
You can prepare for your first contribution by reviewing several steps beforehand. Figure 2 outlines the steps and the details follow.
169+
-->
170+
## 第一次贡献 {#your-first-contribution}
171+
172+
你可以提前查阅几个步骤,来准备你的第一次贡献。
173+
图 2 概述了后续的步骤和细节。
174+
175+
<!-- See https://github.com/kubernetes/website/issues/28808 for live-editor URL to this figure -->
176+
<!-- 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 -->
177+
178+
{{< mermaid >}}
179+
flowchart LR
180+
subgraph second[第一次贡献]
181+
direction TB
182+
S[ ] -.-
183+
G[查阅其他 K8s<br>成员发起的 PR] -->
184+
A[检索 K8s/website<br>问题列表是否有<br>good first 一类的 PR] --> B[发起一个 PR!!]
185+
end
186+
subgraph first[建议的准备工作]
187+
direction TB
188+
T[ ] -.-
189+
D[阅读贡献概述] -->E[阅读 K8s 内容<br>和风格指南]
190+
E --> F[了解 Hugo 页面<br>内容类型<br>和短代码]
191+
end
192+
193+
194+
first ----> second
195+
196+
197+
classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px;
198+
classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold
199+
classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000
200+
class A,B,D,E,F,G grey
201+
class S,T spacewhite
202+
class first,second white
203+
{{</ mermaid >}}
204+
205+
<!--
206+
Figure 2. Preparation for your first contribution.
207+
-->
208+
图 2. 第一次贡献的准备工作。
209+
210+
<!--
117211
- Read the [Contribution overview](/docs/contribute/new-content/overview/) to
118212
learn about the different ways you can contribute.
119213
- Check [`kubernetes/website` issues list](https://github.com/kubernetes/website/issues/)
@@ -127,13 +221,10 @@ roles and permissions.
127221
- Learn about [page content types](/docs/contribute/style/page-content-types/)
128222
and [Hugo shortcodes](/docs/contribute/style/hugo-shortcodes/).
129223
-->
130-
## 第一次贡献 {#your-first-contribution}
131-
132224
- 通读[贡献概述](/zh/docs/contribute/new-content/overview/),了解参与贡献的不同方式。
133-
- 查看[`kubernetes/website` 问题列表](https://github.com/kubernetes/website/issues/)
225+
- 查看 [`kubernetes/website` 问题列表](https://github.com/kubernetes/website/issues/)
134226
,检索最适合作为切入点的问题。
135-
- 在现有文档上,
136-
[使用 GitHub 提交 PR ](/zh/docs/contribute/new-content/open-a-pr/#changes-using-github)
227+
- 在现有文档上,[使用 GitHub 提交 PR](/zh/docs/contribute/new-content/open-a-pr/#changes-using-github)
137228
掌握在 GitHub 上登记 Issue 的方法。
138229
- Kubernetes 社区其他成员会[评审 PR ](/zh/docs/contribute/review/reviewing-prs/)
139230
以确保文档精准和语言流畅。
@@ -157,11 +248,11 @@ roles and permissions.
157248

158249
- 学习在仓库的[本地克隆中工作](/zh/docs/contribute/new-content/open-a-pr/#fork-the-repo)
159250
-[发行版的特性](/zh/docs/contribute/new-content/new-features/)编写文档。
160-
- 加入 [SIG Docs](/zh/docs/contribute/participate/), 并成为[成员或评审者](/zh/docs/contribute/participate/roles-and-responsibilities/)
251+
- 加入 [SIG Docs](/zh/docs/contribute/participate/)并成为[成员或评审者](/zh/docs/contribute/participate/roles-and-responsibilities/)
161252

162253
- 开始或帮助[本地化](/zh/docs/contribute/localization/) 工作。
163254

164-
<!--
255+
<!--
165256
## Get involved with SIG Docs
166257
167258
[SIG Docs](/docs/contribute/participate/) is the group of contributors who
@@ -170,37 +261,47 @@ involved with SIG Docs is a great way for Kubernetes contributors (feature
170261
development or otherwise) to have a large impact on the Kubernetes project.
171262
172263
SIG Docs communicates with different methods:
173-
174-
- [Join `#sig-docs` on the Kubernetes Slack instance](https://slack.k8s.io/). Make sure to
175-
introduce yourself!
176-
- [Join the `kubernetes-sig-docs` mailing list](https://groups.google.com/forum/#!forum/kubernetes-sig-docs),
177-
where broader discussions take place and official decisions are recorded.
178-
- 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.
179264
-->
180265
## 参与 SIG Docs 工作 {#get-involved-with-SIG-Docs}
181266

182267
[SIG Docs](/zh/docs/contribute/participate/) 是负责发布、维护 Kubernetes 文档的贡献者团体。
183268
参与 SIG Docs 是 Kubernetes 贡献者(开发者和其他人员)对 Kubernetes 项目产生重大影响力的好方式。
184269

185-
SIG Docs 的几种沟通方式:
186-
270+
SIG Docs 的几种沟通方式:
271+
<!--
272+
- [Join `#sig-docs` on the Kubernetes Slack instance](https://slack.k8s.io/). Make sure to
273+
introduce yourself!
274+
- [Join the `kubernetes-sig-docs` mailing list](https://groups.google.com/forum/#!forum/kubernetes-sig-docs),
275+
where broader discussions take place and official decisions are recorded.
276+
- 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.
277+
- 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.
278+
-->
187279
- [加入 Kubernetes 在 Slack 上的`#sig-docs` 频道](https://slack.k8s.io/)
188280
一定记得自我介绍!
189-
- [加入`kubernetes-sig-docs` 邮件列表](https://groups.google.com/forum/#!forum/kubernetes-sig-docs),
281+
- [加入 `kubernetes-sig-docs` 邮件列表](https://groups.google.com/forum/#!forum/kubernetes-sig-docs),
190282
这里有更广泛的讨论,和官方决策的记录。
191-
- 参加 [SIG Docs 的每周视频会议](https://github.com/kubernetes/community/tree/master/sig-docs)。会议总是在 `#sig-docs` 上发出公告,同时添加到
192-
[Kubernetes社区会议日历](https://calendar.google.com/calendar/embed?src=cgnt364vd8s86hr2phapfjc6uk%40group.calendar.google.com&ctz=America/Los_Angeles)
283+
- 参加每两周召开一次的 [SIG Docs 视频会议](https://github.com/kubernetes/community/tree/master/sig-docs)
284+
会议总是在 `#sig-docs` 上发出公告,同时添加到
285+
[Kubernetes 社区会议日历](https://calendar.google.com/calendar/embed?src=cgnt364vd8s86hr2phapfjc6uk%40group.calendar.google.com&ctz=America/Los_Angeles)
193286
你需要下载 [Zoom 客户端软件](https://zoom.us/download),或电话拨号接入。
287+
- 如果有几周未召开实况 Zoom 视频会议,请参加 SIG Docs 异步 Slack 站会。
288+
会议总是在 `#sig-docs` 上发出公告。
289+
你可以在会议公告后 24 小时内为其中任一议题做贡献。
194290

195291
<!--
196292
## Other ways to contribute
197293
198294
- Visit the [Kubernetes community site](/community/). Participate on Twitter or Stack Overflow, learn about local Kubernetes meetups and events, and more.
199-
- Read the [contributor cheatsheet](https://github.com/kubernetes/community/tree/master/contributors/guide/contributor-cheatsheet) to get involved with Kubernetes feature development.
295+
- Read the [contributor cheatsheet](https://www.kubernetes.dev/docs/contributor-cheatsheet/) to get involved with Kubernetes feature development.
296+
- Visit the contributor site to learn more about [Kubernetes Contributors](https://www.kubernetes.dev/) and [additional contributor resources](https://www.kubernetes.dev/resources/).
200297
- Submit a [blog post or case study](/docs/contribute/new-content/blogs-case-studies/).
201298
-->
202299
## 其他贡献方式 {#other-ways-to-contribute}
203300

204-
- 访问 [Kubernetes 社区网站](/zh/community/)。 参与 Twitter 或 Stack Overflow, 了解 Kubernetes 当地的聚会和活动, 等等。
205-
- 阅读[贡献者备忘单](https://github.com/kubernetes/community/tree/master/contributors/guide/contributor-cheatsheet),参与 Kubernetes 功能开发。
301+
- 访问 [Kubernetes 社区网站](/zh/community/)
302+
参与 Twitter 或 Stack Overflow,了解当地的 Kubernetes 会议和活动等等。
303+
- 阅读[贡献者备忘单](https://github.com/kubernetes/community/tree/master/contributors/guide/contributor-cheatsheet)
304+
参与 Kubernetes 功能开发。
305+
- 访问贡献者网站,进一步了解有关 [Kubernetes 贡献者](https://www.kubernetes.dev/)
306+
[更多贡献者资源](https://www.kubernetes.dev/resources/)的信息。
206307
- 提交一篇[博客文章或案例研究](/zh/docs/contribute/new-content/blogs-case-studies/)

0 commit comments

Comments
 (0)