担任博客写作搭档
Kubernetes 有两个官方博客,CNCF 也有自己的博客可以涵盖 Kubernetes。阅读 贡献 Kubernetes 博客 了解这两个博客。
当人们以作者身份向任一博客贡献时,Kubernetes 项目会将作者配对为**写作搭档**。本页面解释了如何履行搭档的角色。
在继续阅读本页面之前,你至少应该阅读过 文章提交 的概要。
搭档职责
作为写作搭档,你:
- 帮助博客团队准备好文章进行合并和发布
- 支持你的搭档产出适合合并的内容
- 对你的搭档撰写的文章提供审阅
当团队将你与另一位作者配对时,其想法是你们双方通过审阅彼此的文章草稿来互相支持。阅读 Kubernetes 博客文章的大多数人不是专家;内容应该力求让这部分受众理解,或者至少以适当的方式为非专家读者提供支持。
博客团队也会在从草稿到发布的整个过程中为你提供帮助。他们可以直接批准你的文章发布,或者安排批准流程。
支持博客团队
你在这方面的主要职责是在合理的时间范围内沟通你的能力、可用性和进度。如果数周过去了你的搭档仍未收到你的回复,这会导致整个工作花费更多时间。
支持你的搭档
该过程包含两个部分:
(这是推荐选项)
博客团队建议文章的主要作者使用 Google Doc 或 HackMD(他们选择)设置协作编辑。然后主要作者与以下人员共享该文档:
- 任何共同作者
- 你(他们的写作搭档)
- 理想情况下,包含博客团队的一位指定人员。
作为写作搭档,你随后阅读草稿文本,可以直接提出建议或以其他方式提供反馈。博客的作者通常也是你的写作搭档,因此他们会为你的博客文章草稿提供相同类型的反馈。
你在此的角色是推荐最少的修改集,以使文章看起来适合发表。如果图表确实难以理解,或者文字非常不清晰:请提供反馈。如果你对措辞或标点有细微的不同意见,可以跳过。让文章作者按照自己的风格写作,前提是他们符合 博客指导原则。
准备就绪后,主要作者将开启拉取请求并使用 Markdown 提交文章。然后你提供 审阅。
有些作者喜欢从 协作编辑 开始;另一些则喜欢直接在 GitHub 中操作。
无论他们选择哪种方式,你的角色是提供反馈,以便博客团队能简单地签字确认文章可以作为草稿合并。请参阅 向 Kubernetes 博客提交文章 了解作者需要做什么。
使用 GitHub 的建议功能指出任何需要修改的地方。
一旦 Markdown 和其他内容(例如图片)看起来没问题,你就可以进行正式的 审阅。
拉取请求审阅
遵循 审阅拉取请求 中的博客部分。
当你认为开放的博客拉取请求已足够好可以合并时,请在拉取请求中添加 /lgtm
注释。
这向仓库自动化工具(Prow)表明内容“对我来说看起来不错”(looks good to me)。Prow 会推进后续流程。/lgtm
命令允许你在记录中添加你的意见,无论你是否正式是 Kubernetes 项目的成员。
你或文章作者应该告知博客团队有一篇文章已准备好签字。如提交指南所述,文章在前言部分应该已标记为 draft: true
。
后续步骤
对于作为写作搭档的你来说,**没有第四步**。一旦拉取请求可以合并,博客团队(或贡献者站点的情况,则由贡献者沟通团队)将负责后续工作。根据反馈,你可能会需要回到之前的某个步骤,但通常你可以认为作为搭档的工作已完成。