作为博客写作伙伴提供帮助
Kubernetes 有两个官方博客,CNCF 也有自己的博客,你也可以在上面发布有关 Kubernetes 的内容。请阅读 为 Kubernetes 博客投稿 以了解这两个博客。
当人们作为作者向任一博客投稿时,Kubernetes 项目会将作者配对为“写作伙伴”。本页面解释了如何履行伙伴角色。
在继续阅读本页面之前,您应确保至少已阅读了 文章提交 的大纲。
伙伴职责
作为写作伙伴,您将
- 帮助博客团队准备好要合并和发布的文章
- 支持您的伙伴创作出适合合并的内容
- 对您的伙伴撰写的文章进行审阅
当团队将您与另一位作者配对时,想法是你们双方通过审阅对方的草稿文章来互相支持。大多数阅读 Kubernetes 博客文章的人并非专家;内容应尽量让该受众容易理解,或至少适当支持非专家读者。
博客团队也会在从草稿到发布的整个过程中提供帮助。他们将直接批准您的文章发布,或者可以安排批准流程。
支持博客团队
您在此的主要责任是在合理的时间内沟通您的能力、可用性和进展。如果很多周过去了,您的伙伴仍未收到您的消息,这将使整体工作耗费更长的时间。
支持您的伙伴
此过程分为两个部分
(这是推荐的选项)
博客团队建议文章的主要作者使用 Google Docs 或 HackMD (由他们选择) 设置协作编辑。然后,主要作者将该文档与以下人员共享:
- 任何联合作者
- 您 (他们的写作伙伴)
- 理想情况下,还包括一名指定的博客团队成员。
作为写作伙伴,您将阅读草稿文本,并直接提出建议或以其他方式提供反馈。博客作者通常也同时是您的写作伙伴,因此他们会以同样的方式对您的博客文章草稿提供反馈。
您的角色是推荐最少的更改,以使文章在发布时看起来很好。如果有一个图表确实不合逻辑,或者写作非常不清晰:请提供反馈。如果您对措辞或标点符号有细微的意见分歧,请忽略。让文章作者以他们自己的风格写作,前提是他们符合 博客指南。
在此准备就绪后,首席作者将打开一个拉取请求,并使用 Markdown 提交文章。然后,您提供一个 审阅。
一些作者更喜欢从 协作编辑 开始;其他人则喜欢直接进入 GitHub。
无论他们选择哪种方式,您的角色是提供反馈,让博客团队能够进行简单的签核并确认文章可以作为草稿合并。有关作者需要做什么,请参阅 将文章提交给 Kubernetes 博客。
使用 GitHub 的建议功能指出任何必需的更改。
一旦 Markdown 和其他内容 (如图片) 看起来没问题,您就提供一个正式的 审阅。
拉取请求审阅
请遵循《审阅拉取请求》中有关 博客的部分。
当您认为打开的博客拉取请求足够好可以合并时,在拉取请求中添加 /lgtm
命令。
这表示“我同意”(looks good to me) 的意见,并会指示仓库自动化工具 (Prow) 继续处理。/lgtm
命令可以让您发表意见,无论您是否是 Kubernetes 项目的正式成员。
您或文章作者应该告知博客团队,有一篇文章已准备好进行签核。根据提交指南的说明,它应该已经在 front matter 中标记为 draft: true
。
后续步骤
对于您作为写作伙伴,没有第四步。一旦拉取请求可以合并,博客团队 (或贡献者站点的贡献者沟通团队) 将接手处理。根据反馈,您可能需要返回到之前的步骤,但通常您可以期望您的伙伴工作已经完成。