作为博客写作伙伴提供帮助
Kubernetes 官方博客有两个,CNCF 也有自己的博客,你也可以在这些博客上发表 Kubernetes 相关内容。请阅读 为 Kubernetes 博客贡献,了解这两个博客的信息。
当人们作为作者为这两个博客之一贡献内容时,Kubernetes 项目会将作者配对为写作伙伴。本页解释如何履行伙伴角色。
在继续阅读本页之前,请确保你至少阅读过 文章提交 的大纲。
伙伴职责
作为写作伙伴,你
- 帮助博客团队准备好合并和发布文章
- 支持你的伙伴创作出适合合并的内容
- 对你的伙伴撰写的文章进行评审
当团队将你与另一位作者配对时,你们的目的是互相支持,通过评审对方的草稿文章。Kubernetes 博客上的大多数读者不是专家;内容应尽量对该受众有意义,或者至少要适当支持非专家读者。
博客团队也会在从草稿到发布的整个过程中帮助你们。他们可以直接批准你的文章发布,或者安排进行批准。
支持博客团队
你的主要职责是合理地沟通你的能力、可用性和进度。如果经过很多周,你的伙伴还没有收到你的消息,那么整体工作就会花费更多的时间。
支持你的伙伴
这个过程分为两个部分
(这是推荐选项)
博客团队建议文章的主要作者使用 Google Doc 或 HackMD(由他们选择)设置协作编辑。主要作者然后与以下人员共享该文档
- 任何联合作者
- 你(他们的写作伙伴)
- 理想情况下,与博客团队的指定人员一起。
作为写作伙伴,你然后阅读草稿文本,并直接提出建议或以其他方式提供反馈。博客文章的作者通常也是你的写作伙伴,因此他们将对你的博客文章草稿提供相同类型的反馈。
你的角色是推荐最少的一组更改,以使文章看起来适合发布。如果有一个图表确实没有意义,或者写作确实不清楚:提供反馈。如果你对措辞或标点符号有轻微的不同意见,请跳过它。让文章作者以符合 博客指南 的风格写作。
准备好后,主要作者将打开一个拉取请求并使用 Markdown 提交文章。然后你提供一个 评审。
有些作者更喜欢从 协作编辑 开始;另一些人则喜欢直接进入 GitHub。
无论他们选择哪种方式,你的角色都是提供反馈,让博客团队能够提供简单的批准并确认文章可以合并为草稿。请参阅 向 Kubernetes 博客提交文章,了解作者需要执行的操作。
使用 GitHub 建议指出任何必需的更改。
一旦 Markdown 和其他内容(例如图像)看起来正确,你就可以提供正式的 评审。
拉取请求评审
遵循 博客 部分的评审拉取请求。
当你认为开放的博客拉取请求足以合并时,将 /lgtm 注释添加到拉取请求中。
这表明仓库自动化工具(Prow)内容“看起来不错”。Prow 会推进工作。/lgtm 命令允许你将你的意见添加到记录中,无论你是否正式是 Kubernetes 项目的成员。
你或文章作者应该通知博客团队文章已准备好进行批准。它应该已经在正文中标记为 draft: true,如提交指南中所述。
后续步骤
对于你作为写作伙伴来说,没有第四步。一旦拉取请求可以合并,博客团队(或者对于贡献者站点,贡献者沟通团队)就会接管后续工作。你可能需要根据反馈返回到之前的步骤,但通常可以预期你的伙伴工作已经完成。