From 3ea0731b394ea494566db529b01201edba748271 Mon Sep 17 00:00:00 2001 From: "xin.li" Date: Tue, 8 Apr 2025 14:53:00 +0800 Subject: [PATCH] [zh-cn] add contribute/blog/buddying.md Signed-off-by: xin.li --- .../zh-cn/docs/contribute/blog/buddying.md | 212 ++++++++++++++++++ 1 file changed, 212 insertions(+) create mode 100644 content/zh-cn/docs/contribute/blog/buddying.md diff --git a/content/zh-cn/docs/contribute/blog/buddying.md b/content/zh-cn/docs/contribute/blog/buddying.md new file mode 100644 index 0000000000..3a907bd1d2 --- /dev/null +++ b/content/zh-cn/docs/contribute/blog/buddying.md @@ -0,0 +1,212 @@ +--- +title: 作为博客写作伙伴提供帮助 +slug: writing-buddy +content_type: concept +weight: 70 +--- + + + + + +Kubernetes 有两个官方博客,同时 CNCF 也有自己的博客,你也可以在其中撰写与 Kubernetes 相关的内容。 +阅读[为 Kubernetes 博客贡献内容](/zh-cn/docs/contribute/blog/)以了解这两个博客的详细信息。 + +当人们作为作者为任一博客撰稿时,Kubernetes 项目会将作者配对为**写作伙伴**。 +本页面解释了如何履行伙伴角色。 + +在继续阅读本页面之前,你应该确保至少已经阅读了[文章提交](/zh-cn/docs/contribute/blog/submission/)的概述。 + + + + +## 伙伴职责 + +作为写作伙伴,你的职责包括: + +* 协助博客团队准备文章,使其达到可合并和发布的状态; +* 支持你的伙伴创作高质量的内容,确保其适合合并; +* 对你伙伴撰写的文章提供审阅意见。 + + +当团队将你与另一位作者配对时,理念是你们通过互相审阅对方的草稿文章来彼此支持。 +大多数阅读 Kubernetes 博客文章的读者并非专家; +内容应当尝试为这类读者群体提供易于理解的信息,或者至少适当地支持非专家读者。 + +博客团队也会在整个从草稿到发布的流程中帮助你们。他们可以直接批准你的文章发布, +或者安排相应的批准流程。 + + +## 支持博客团队 + +你的主要职责是及时沟通你的工作量、可用时间以及进展情况。如果几周过去了, +你的伙伴还没有收到你的消息,这将会导致整体工作花费更多的时间。 + + +## 支持你的伙伴 + +支持伙伴的过程分为两个部分: + +{{< tabs name="buddy_support" >}} +{{% tab name="协同编辑" %}} + +**(这是推荐的选项)** + +博客团队建议文章的主要作者通过 Google Doc 或 HackMD(由作者选择)构造协作编辑环境。 +之后,主作者将该文档共享给以下人员: + +- 所有共同作者 +- 你(他们的写作伙伴) +- 理想情况下,还应包括一位博客团队中指定的负责人。 + + +作为写作伙伴,你需要阅读草稿内容,并直接提出建议或以其他方式提供反馈。 +博客文章的作者通常也会反过来成为**你的**写作伙伴, +因此他们会针对你所撰写的文章草稿提供类似的反馈。 + + +你的角色是推荐最小的修改集,以使文章适合发布。如果某个图表完全无法理解, +或者文字表达非常不清晰,请提供反馈。如果你对措辞或标点符号有轻微的不同意见, +请忽略它。只要符合[博客指南](/zh-cn/docs/contribute/blog/guidelines/), +让文章作者以他们自己的风格写作即可。 + +在此完成后,主作者将发起一个 PR 并使用 Markdown 提交文章。 +然后你可以提供[审阅](#pull-request-review)意见。 + +{{% /tab %}} +{{% tab name="Markdown / Git 编辑" %}} + +一些作者更喜欢从[协同编辑](#buddy-support-0)开始, +而另一些人则喜欢直接进入 GitHub。 + +无论他们选择哪种方式,你的角色是提供反馈,使博客团队能够轻松完成审核, +并确认文章可以作为草稿合并。有关作者需要完成的操作, +请参阅[向 Kubernetes 博客提交文章](/zh-cn/docs/contribute/blog/submission/)。 + + +使用 GitHub 的建议功能指出需要修改的地方。 + +一旦 Markdown 文件和其他内容(例如图片)看起来没有问题, +你就可以提供正式的[审阅](#pull-request-review)意见。 + +{{% /tab %}} +{{< /tabs >}} + + +## 审阅 PR + +遵循**审阅 PR **一文的[博客](/zh-cn/docs/contribute/review/reviewing-prs/#blog)部分所给的要求。 + +当你认为所发起的博客 PR 足够好可以合并时,在 PR 中添加 `/lgtm` 评论。 + + +这一注释向仓库自动化工具(Prow)内容申明内容“在我看来没有问题”。 +Prow 会推进相关流程。`/lgtm` 命令允许你将自己的意见公开出来, +无论你是否正式成为 Kubernetes 项目的一员。 + +你或文章作者应通知博客团队有文章已准备好进行签发。根据提交指南, +文章前面应已标记为 `draft: true`。 + + +## 后续步骤 + +作为写作伙伴,**没有第四步**。一旦 PR 准备好合并, +博客团队(或者,对于贡献者网站,贡献者通信团队)将会接手。 +根据反馈,你可能需要返回到前面的步骤,但通常你可以认为作为伙伴的工作已经完成。