Skip to content

Commit 0267aff

Browse files
k8s-ci-robotk8s-ci-robot
authored
Merge pull request #50433 from my-git9/np-28390
[zh-cn] add contribute/blog/buddying.md
2 parents c5ce624 + 3ea0731 commit 0267aff

File tree

1 file changed

+212
-0
lines changed

1 file changed

+212
-0
lines changed

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

Lines changed: 212 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,212 @@
1+
---
2+
title: 作为博客写作伙伴提供帮助
3+
slug: writing-buddy
4+
content_type: concept
5+
weight: 70
6+
---
7+
<!--
8+
title: Helping as a blog writing buddy
9+
slug: writing-buddy
10+
content_type: concept
11+
weight: 70
12+
-->
13+
14+
<!-- overview -->
15+
16+
<!--
17+
There are two official Kubernetes blogs, and the CNCF has its own blog where you can cover Kubernetes too.
18+
Read [contributing to Kubernetes blogs](/docs/contribute/blog/) to learn about these two blogs.
19+
20+
When people contributor to either blog as an author, the Kubernetes project pairs up authors
21+
as _writing buddies_. This page explains how to fulfil the buddy role.
22+
23+
You should make sure that you have at least read an outline of [article submission](/docs/contribute/blog/submission/)
24+
before you read on within this page.
25+
-->
26+
Kubernetes 有两个官方博客，同时 CNCF 也有自己的博客，你也可以在其中撰写与 Kubernetes 相关的内容。
27+
阅读[为 Kubernetes 博客贡献内容](/zh-cn/docs/contribute/blog/)以了解这两个博客的详细信息。
28+
29+
当人们作为作者为任一博客撰稿时，Kubernetes 项目会将作者配对为**写作伙伴**。
30+
本页面解释了如何履行伙伴角色。
31+
32+
在继续阅读本页面之前，你应该确保至少已经阅读了[文章提交](/zh-cn/docs/contribute/blog/submission/)的概述。
33+
34+
<!-- body -->
35+
36+
<!--
37+
## Buddy responsibilities
38+
39+
As a writing buddy, you:
40+
41+
* help the blog team get articles ready to merge and to publish
42+
* support your buddy to produce content that is good to merge
43+
* provide a review on the article that your buddy has written
44+
-->
45+
## 伙伴职责
46+
47+
作为写作伙伴，你的职责包括：
48+
49+
* 协助博客团队准备文章，使其达到可合并和发布的状态；
50+
* 支持你的伙伴创作高质量的内容，确保其适合合并；
51+
* 对你伙伴撰写的文章提供审阅意见。
52+
53+
<!--
54+
When the team pairs you up with another author, the idea is that you both support each other by
55+
reviewing the other author's draft article.
56+
Most people reading articles on the Kubernetes blog are not experts; the content should
57+
try to make sense for that audience, or at least to support non-expert readers appropriately.
58+
59+
The blog team are also there to help you both along the journey from draft to publication.
60+
They will either be directly able to approve your article for publication, or can arrange for
61+
the approval to happen.
62+
-->
63+
当团队将你与另一位作者配对时，理念是你们通过互相审阅对方的草稿文章来彼此支持。
64+
大多数阅读 Kubernetes 博客文章的读者并非专家；
65+
内容应当尝试为这类读者群体提供易于理解的信息，或者至少适当地支持非专家读者。
66+
67+
博客团队也会在整个从草稿到发布的流程中帮助你们。他们可以直接批准你的文章发布，
68+
或者安排相应的批准流程。
69+
70+
<!--
71+
## Supporting the blog team
72+
73+
Your main responsibility here is to communicate about your capacity, availability and progress
74+
in a reasonable timeline. If many weeks go by and your buddy hasn't heard from you, it makes
75+
the overall work take more time.
76+
-->
77+
## 支持博客团队
78+
79+
你的主要职责是及时沟通你的工作量、可用时间以及进展情况。如果几周过去了，
80+
你的伙伴还没有收到你的消息，这将会导致整体工作花费更多的时间。
81+
82+
<!--
83+
## Supporting your buddy
84+
85+
There are two parts to the process
86+
-->
87+
## 支持你的伙伴
88+
89+
支持伙伴的过程分为两个部分：
90+
91+
{{< tabs name="buddy_support" >}}
92+
{{% tab name="协同编辑" %}}
93+
<!--
94+
**(This is the recommended option)**
95+
96+
The blog team recommend that the main author for the article sets up collaborative editing
97+
using either a Google Doc or HackMD (their choice). The main author then shares that document
98+
with the following people:
99+
100+
* Any co-authors
101+
* You (their writing buddy)
102+
* Ideally, with a nominated
103+
person from the blog team.
104+
-->
105+
**（这是推荐的选项）**
106+
107+
博客团队建议文章的主要作者通过 Google Doc 或 HackMD（由作者选择）构造协作编辑环境。
108+
之后，主作者将该文档共享给以下人员：
109+
110+
- 所有共同作者
111+
- 你（他们的写作伙伴）
112+
- 理想情况下，还应包括一位博客团队中指定的负责人。
113+
114+
<!--
115+
As a writing buddy, you then read the draft text and either directly make suggestions or provide
116+
feedback in a different way. The author of the blog is very commonly also **your** writing buddy in turn, so they will provide the
117+
same kind of feedback on the draft for your blog article.
118+
-->
119+
作为写作伙伴，你需要阅读草稿内容，并直接提出建议或以其他方式提供反馈。
120+
博客文章的作者通常也会反过来成为**你的**写作伙伴，
121+
因此他们会针对你所撰写的文章草稿提供类似的反馈。
122+
123+
<!--
124+
Your role here is to recommend the smallest set of changes that will get the article look good
125+
for publication. If there's a diagram that really doesn't make sense, or the writing is really
126+
unclear: provide feedback. If you have a slight different of opinion about wording or punctuation,
127+
skip it. Let the article author(s) write in their own style, provided that they align to
128+
the [blog guidelines](/docs/contribute/blog/guidelines/).
129+
130+
After this is ready, the lead author will open a pull request and use Markdown to submit the
131+
article. You then provide a [review](#pull-request-review).
132+
-->
133+
你的角色是推荐最小的修改集，以使文章适合发布。如果某个图表完全无法理解，
134+
或者文字表达非常不清晰，请提供反馈。如果你对措辞或标点符号有轻微的不同意见，
135+
请忽略它。只要符合[博客指南](/zh-cn/docs/contribute/blog/guidelines/)，
136+
让文章作者以他们自己的风格写作即可。
137+
138+
在此完成后，主作者将发起一个 PR 并使用 Markdown 提交文章。
139+
然后你可以提供[审阅](#pull-request-review)意见。
140+
141+
{{% /tab %}}
142+
{{% tab name="Markdown / Git 编辑" %}}
143+
<!--
144+
Some authors prefer to start with
145+
[collaborative editing](#buddy-support-0); others like to go straight into
146+
GitHub.
147+
148+
Whichever route they take, your role is to provide feedback that lets the blog team provide
149+
a simple signoff and confirm that the article can merge as a draft. See
150+
[submitting articles to Kubernetes blogs](/docs/contribute/blog/submission/) for what the authors
151+
need to do.
152+
-->
153+
一些作者更喜欢从[协同编辑](#buddy-support-0)开始，
154+
而另一些人则喜欢直接进入 GitHub。
155+
156+
无论他们选择哪种方式，你的角色是提供反馈，使博客团队能够轻松完成审核，
157+
并确认文章可以作为草稿合并。有关作者需要完成的操作，
158+
请参阅[向 Kubernetes 博客提交文章](/zh-cn/docs/contribute/blog/submission/)。
159+
160+
<!--
161+
Use GitHub suggestions to point out any required changes.
162+
163+
Once the Markdown and other content (such as images) look right, you provide a
164+
formal [review](#pull-request-review).
165+
-->
166+
使用 GitHub 的建议功能指出需要修改的地方。
167+
168+
一旦 Markdown 文件和其他内容（例如图片）看起来没有问题，
169+
你就可以提供正式的[审阅](#pull-request-review)意见。
170+
171+
{{% /tab %}}
172+
{{< /tabs >}}
173+
174+
<!--
175+
## Pull request review
176+
177+
Follow the [blog](/docs/contribute/review/reviewing-prs/#blog) section of _Reviewing pull requests_.
178+
179+
When you think that the open blog pull request is good enough to merge, add the `/lgtm` comment to the pull request.
180+
-->
181+
## 审阅 PR
182+
183+
遵循**审阅 PR **一文的[博客](/zh-cn/docs/contribute/review/reviewing-prs/#blog)部分所给的要求。
184+
185+
当你认为所发起的博客 PR 足够好可以合并时，在 PR 中添加 `/lgtm` 评论。
186+
187+
<!--
188+
This indicates to the repository automation tooling (Prow) that the content "looks good to me". Prow moves things forward. The `/lgtm` command lets you add your opinion to the record whether or not you are formally a member of the Kubernetes project.
189+
190+
Either you or the article author(s) should let the blog team know that there is an article
191+
ready for signoff. It should already be marked as `draft: true` in the front matter, as
192+
explained in the submission guidance.
193+
-->
194+
这一注释向仓库自动化工具（Prow）内容申明内容“在我看来没有问题”。
195+
Prow 会推进相关流程。`/lgtm` 命令允许你将自己的意见公开出来，
196+
无论你是否正式成为 Kubernetes 项目的一员。
197+
198+
你或文章作者应通知博客团队有文章已准备好进行签发。根据提交指南，
199+
文章前面应已标记为 `draft: true`。
200+
201+
<!--
202+
## Subsequent steps
203+
204+
For you as a writing buddy, **there is no step four**. Once the pull request is good to merge,
205+
the blog team (or, for the contributor site, the contributor comms team) take things from there.
206+
It's possible that you'll need to return to an earlier step based on feedback, but you can usually expect that your work as a buddy is done.
207+
-->
208+
## 后续步骤
209+
210+
作为写作伙伴，**没有第四步**。一旦 PR 准备好合并，
211+
博客团队（或者，对于贡献者网站，贡献者通信团队）将会接手。
212+
根据反馈，你可能需要返回到前面的步骤，但通常你可以认为作为伙伴的工作已经完成。

0 commit comments

Comments
 (0)