Skip to content

Commit 77713d0

Browse files
k8s-ci-robotk8s-ci-robot
authored
Merge pull request #46396 from windsonsea/sigdocs
[zh] Localize 2024-04-28-contribute-as-sig-docs-reviewer.md
2 parents 0632982 + 31151ea commit 77713d0

File tree

1 file changed

+220
-0
lines changed

1 file changed

+220
-0
lines changed

‎content/zh-cn/blog/_posts/2024-04-28-contribute-as-sig-docs-reviewer.md

Lines changed: 220 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,220 @@
1+
---
2+
layout: blog
3+
title: "从敲代码到抒发文笔：与 SIG Docs 一起踏上传奇的 Kubernetes 探险之旅"
4+
date: 2024-05-16
5+
slug: contribute-as-sig-docs-reviewer
6+
canonicalUrl: https://www.kubernetes.dev/blog/2024/05/16/contribute-as-sig-docs-reviewer/
7+
author: "Ricardo Amaro (Acquia)"
8+
translator: "Michael Yao (DaoCloud)"
9+
---
10+
<!--
11+
layout: blog
12+
title: "From Code to Quill: Embark on a Legendary Kubernetes Quest with SIG Docs"
13+
date: 2024-05-16
14+
slug: contribute-as-sig-docs-reviewer
15+
canonicalUrl: https://www.kubernetes.dev/blog/2024/05/16/contribute-as-sig-docs-reviewer/
16+
author: "Ricardo Amaro (Acquia)"
17+
-->
18+
19+
<!--
20+
You've likely heard the adage, "Contributing isn't just about writing code",
21+
whispered in forums or seen etched into the digital walls of open source communities.
22+
But what depth of truth lies within this ancient wisdom, especially in the vast,
23+
evolving world of Kubernetes?
24+
25+
Today, contributing to open source extends far beyond the realm of coding.
26+
It's an inclusive journey that welcomes the diverse skills of all who wish
27+
to be a part of it. Whether you're a seasoned developer or someone whose strengths
28+
lie outside traditional programming, your contributions hold immense value.
29+
-->
30+
你可能在论坛中听过或在开源社区的数字墙上见过这么一句格言：“做贡献不仅仅是写代码”。
31+
特别是在这个广阔、不断发展的 Kubernetes 社区中，这句古老的智慧格言真正意味着什么呢？
32+
33+
如今，为开源做贡献远远超出了敲代码的范畴。
34+
做贡献是一段内涵丰富的旅程，我们欢迎所有有志之士展露自己的各类技能。
35+
不论你是经验丰富的开发者，还是在传统编程之外拥有特长的人，你的贡献都有很大价值。
36+
37+
<!--
38+
Imagine yourself embarking on a journey that leverages your expertise and love
39+
for free software to enhance your capabilities and strengthen the very foundation
40+
of the Kubernetes ecosystem. This is a real opportunity for you to shine, to make
41+
an indelible mark on a project that powers some of the most critical infrastructure
42+
in the world today.
43+
-->
44+
想象一下，踏上一段这样的旅程，既能充分发挥你的专业知识，又能尽情抒展你对自由软件的热爱，
45+
在这个贡献过程中既增强了你的能力，又巩固了 Kubernetes 生态体系的基础。
46+
这是一个让你闪耀光芒的真正机遇，能够让你在支撑当今世界某些最关键基础设施的项目上留下不可磨灭的印记。
47+
48+
<!--
49+
Your journey begins with a single step: joining the Special Interest Group (SIG) Docs.
50+
Here, your talent for articulating complex concepts, your keen eye for detail,
51+
and your unwavering commitment to clarity become your most powerful tools. As a contributor,
52+
you can transform dense technical landscapes into navigable pathways, making Kubernetes
53+
accessible to all.
54+
-->
55+
你的旅程始于简单的一步：加入特别兴趣小组 (SIG) Docs。
56+
在这个小组，你对复杂概念的表达能力、对细节的敏锐眼光以及对清晰易懂的不懈追求将成为你最强大的工具。
57+
作为一名贡献者，你将从密集复杂的技术内容中找出一条易于上手的路径，让大众都能使用 Kubernetes。
58+
59+
<!--
60+
This is your call to adventure, an invitation to expand beyond the familiar territories
61+
of code and into the rich, uncharted domains of documentation and collaboration,
62+
empowering a global community of users and contributors.
63+
-->
64+
这是一次有关冒险的召唤，一份超越代码领域的邀请，指引你踏入文档创作与社区协作的未知境地。
65+
在这里，你将为全球用户和贡献者组成的社区赋能，点亮他们前行的道路。
66+
67+
<!--
68+
## Why become a SIG Docs reviewer?
69+
70+
The Kubernetes project depends substantially on the SIG Docs to ensure that documentation
71+
is accurate, up to date, and easily accessible. By becoming a reviewer, you can help users
72+
and contributors navigate and understand Kubernetes more effectively. In addition, reviewing
73+
documentation provides unique opportunities for:
74+
-->
75+
## 为什么要成为 SIG Docs Reviewer？ {#why-become-a-sig-docs-reviewer}
76+
77+
Kubernetes 项目在很大程度上依赖于 SIG Docs 小组成员们确保文档准确无误、与时俱进、好用易懂。
78+
你成为 Reviewer 后，就可以帮助用户和贡献者们更有效地探索和学习 Kubernetes。
79+
此外，你在评审文档时还将收获一些独特的机会：
80+
81+
<!--
82+
- **Expanding your Kubernetes knowledge**: Engage deeply with new features and functionalities
83+
by reviewing their documentation.
84+
- **Improving your technical writing skills**: Develop an eye for detail and clarity in technical
85+
writing.
86+
- **Strengthening the Kubernetes community**: Help maintain the high quality of Kubernetes
87+
documentation, supporting both new and experienced users.
88+
- **Building your network**: Expanding your professional network, and getting together with
89+
contributors from around the globe.
90+
-->
91+
- **拓展你的 Kubernetes 知识**：通过评审文档深入了解新的功能特性。
92+
- **提高你的技术写作技巧**：培养技术写作中注重细节和清晰阐述的能力。
93+
- **巩固 Kubernetes 社区**：帮助维护优质的 Kubernetes 文档，方便新老用户查阅。
94+
- **建立你的人脉**：拓展你的专业人际网络，认识来自全球的贡献者。
95+
96+
<!--
97+
## Who are we looking for?
98+
99+
We're seeking open source enthusiasts with:
100+
-->
101+
## 我们在寻找什么样的人？ {#who-are-we-looking-for}
102+
103+
我们正在寻找对开源充满热情且具备以下能力的人士：
104+
105+
<!--
106+
- Experience of Git and GitHub, comfortable with the process of reviewing pull requests
107+
and providing constructive feedback.
108+
- Familiarity with Markdown and documentation frameworks (Hugo experience is a plus but
109+
not required).
110+
- A passion for making complex technical concepts understandable and accessible.
111+
-->
112+
- 拥有 Git 和 GitHub 的经验，熟悉评审 PR 的流程，并能提供建设性的反馈。
113+
- 熟悉 Markdown 和文档框架（有 Hugo 经验是加分项，但不是必需的）。
114+
- 热衷于让复杂的技术概念变得易懂好用。
115+
116+
<!--
117+
Experience in technical writing or documentation review in open source projects is beneficial,
118+
but not mandatory. Kubernetes experience is welcome at all levels. Those less familiar
119+
with Kubernetes or containers can provide valuable fresh perspectives for beginners accessibility.
120+
We value diversity of experiences and the fresh eyes you can provide to make sure our content
121+
is clear and understandable for everyone.
122+
-->
123+
在开源项目中有技术写作或文档评审经验是加分项，但并非必需。我们欢迎对 Kubernetes 有各种经验的贡献者。
124+
那些对 Kubernetes 或容器不太熟悉的新人，可以为初学者提供宝贵的全新视角。
125+
我们重视多样化的经验和新视角，以确保我们的文档内容对每个人都清晰易懂。
126+
127+
<!--
128+
## How to get started
129+
130+
Becoming a SIG Docs reviewer is a journey that starts with familiarizing yourself with the
131+
Kubernetes documentation contribution process. Here are the steps to get you started:
132+
-->
133+
## 如何开始 {#how-to-get-started}
134+
135+
成为 SIG Docs Reviewer 是一段从熟悉 Kubernetes 文档贡献流程开始的旅程。以下是入门步骤：
136+
137+
<!--
138+
1. **Familiarize Yourself with SIG Docs**: Start by reading the
139+
[SIG Docs contributor guide](/docs/contribute/) to understand
140+
how documentation contributions are made.
141+
142+
1. **Join the Kubernetes Slack**: Connect with the SIG Docs community on the
143+
[#sig-docs channel](https://kubernetes.slack.com/messages/sig-docs). It's a great place
144+
to ask questions, find mentorship, and get to know the community.
145+
-->
146+
1. **熟悉 SIG Docs**：首先阅读 [SIG Docs 贡献者指南](/zh-cn/docs/contribute/)，了解如何做文档贡献。
147+
148+
2. **加入 Kubernetes Slack**：在 [#sig-docs 频道](https://kubernetes.slack.com/messages/sig-docs)与
149+
SIG Docs 社区建立联系。Slack 是一个提问、寻求指教和了解社区的好地方。
150+
151+
<!--
152+
1. **Start Reviewing Pull Requests**: Look for open pull requests labeled with
153+
`good first issue` or `help wanted`. These are great for beginners. Leave constructive
154+
feedback and suggestions. Familiarize yourself with the
155+
[content guide](/docs/contribute/style/content-guide/) and the
156+
[style guide](/docs/contribute/style/style-guide/) to provide more effectively
157+
[reviewing Pull Requests](/docs/contribute/review/reviewing-prs/).
158+
-->
159+
3. **开始评审 PR**：查找打了 `good first issue` 或 `help wanted` 标签的开放 PR。
160+
这些 PR 对 Reviewer 新手来说是很好的选择。你可以在其中留下建设性的反馈和建议。
161+
你还要熟悉[内容指南](/zh-cn/docs/contribute/style/content-guide/)和[样式指南](/zh-cn/docs/contribute/style/style-guide/)，
162+
以便更有效地[评审 PR](/zh-cn/docs/contribute/review/reviewing-prs/)。
163+
164+
<!--
165+
1. **Attend SIG Docs Meetings**: Participate in the
166+
[SIG Docs meetings](https://github.com/kubernetes/community/tree/master/sig-docs). These
167+
meetings are an excellent opportunity to meet fellow contributors, discuss documentation
168+
improvements, and volunteer for reviewing tasks.
169+
-->
170+
4. **参加 SIG Docs 会议**：参与 [SIG Docs 会议](https://github.com/kubernetes/community/tree/master/sig-docs)。
171+
这些会议是结识其他贡献者、讨论文档改进和志愿评审任务的绝佳机会。
172+
173+
<!--
174+
1. **Shadow an Experienced Reviewer**: To better understand the review process, sign up for our official
175+
[PR Wrangling shadow program](/docs/contribute/participate/pr-wranglers/#pr-wrangler-shadow-program)
176+
where you will be able to shadow an [experienced reviewer](/docs/contribute/participate/roles-and-responsibilities/)
177+
and learn best practices and tips for reviewing efficiently and effectively.
178+
-->
179+
5. **成为资深 Reviewer 的影子**：若想更好地理解评审过程，请报名参加我们的
180+
[PR 管理影子计划](/zh-cn/docs/contribute/participate/pr-wranglers/#pr-wrangler-shadow-program)，
181+
你将能够成为[资深 Reviewer](/zh-cn/docs/contribute/participate/roles-and-responsibilities/)的影子，
182+
学习高效和有效评审的良好实践和技巧。
183+
184+
<!--
185+
1. **Contributor Ladder**: Familiarize yourself with the
186+
[CNCF contributor ladder](https://github.com/cncf/project-template/blob/main/CONTRIBUTOR_LADDER.md),
187+
which guides your progression from newcomer to advanced contributor roles in the Kubernetes community.
188+
-->
189+
6. **贡献者阶梯**：熟悉 [CNCF 贡献者阶梯](https://github.com/cncf/project-template/blob/main/CONTRIBUTOR_LADDER.md)，
190+
这能帮助你从新手进阶为 Kubernetes 社区中高级贡献者角色。
191+
192+
<!--
193+
## What's next?
194+
195+
After consistently contributing to documentation reviews and demonstrating your understanding
196+
of Kubernetes documentation standards, you can express your interest in becoming an official
197+
SIG Docs reviewer. Engage with the SIG Docs chairs or leads on the
198+
[public Slack channel](https://kubernetes.slack.com/channels/C1J0BPD2M)
199+
or during SIG Docs meetings to discuss the next steps.
200+
-->
201+
## 接下来 {#whats-next}
202+
203+
在文档评审方面持续贡献并展示你对 Kubernetes 文档标准的理解后，你可以表达成为正式 SIG Docs Reviewer 的兴趣。
204+
你可以在[公共 Slack 频道](https://kubernetes.slack.com/channels/C1J0BPD2M)或 SIG Docs 会议期间与
205+
SIG Docs Chair 或 Lead 讨论后续步骤。
206+
207+
<!--
208+
## See _you_ in the docs!
209+
210+
Becoming a SIG Docs reviewer is more than contributing; it's embracing the heart of the
211+
Kubernetes community 🚀. Enhance your knowledge and writing skills while contributing
212+
to our valuable documentation. This is your opportunity to guide others with your expertise
213+
and make a lasting impact. Welcome aboard—see you there! 🌟
214+
-->
215+
## 希望在文档中看到**你的名字**！ {#see-you-in-the-docs}
216+
217+
成为 SIG Docs Reviewer 不仅仅是做贡献；这说明你已进入 Kubernetes 社区的核心 🚀。
218+
你在为宝贵文档做贡献的同时也能提升自己的理论知识和写作技巧。
219+
这是你用自己的专业知识指导他人并产生持久影响的机会。
220+
欢迎你加入团队，我们在 SIG Docs 不见不散！🌟

0 commit comments

Comments
 (0)