作为博客写作伙伴提供帮助
Kubernetes 有两个官方博客,同时 CNCF 也有自己的博客,你也可以在其中撰写与 Kubernetes 相关的内容。
阅读为 Kubernetes 博客贡献内容以了解这两个博客的详细信息。
当人们作为作者为任一博客撰稿时,Kubernetes 项目会将作者配对为写作伙伴。 本页面解释了如何履行伙伴角色。
在继续阅读本页面之前,你应该确保至少已经阅读了文章提交的概述。
伙伴职责
作为写作伙伴,你的职责包括:
- 协助博客团队准备文章,使其达到可合并和发布的状态;
- 支持你的伙伴创作高质量的内容,确保其适合合并;
- 对你伙伴撰写的文章提供审阅意见。
当团队将你与另一位作者配对时,理念是你们通过互相审阅对方的草稿文章来彼此支持。 大多数阅读 Kubernetes 博客文章的读者并非专家; 内容应当尝试为这类读者群体提供易于理解的信息,或者至少适当地支持非专家读者。
博客团队也会在整个从草稿到发布的流程中帮助你们。他们可以直接批准你的文章发布, 或者安排相应的批准流程。
支持博客团队
你的主要职责是及时沟通你的工作量、可用时间以及进展情况。如果几周过去了, 你的伙伴还没有收到你的消息,这将会导致整体工作花费更多的时间。
支持你的伙伴
支持伙伴的过程分为两个部分:
(这是推荐的选项)
博客团队建议文章的主要作者通过 Google Doc 或 HackMD(由作者选择)构造协作编辑环境。 之后,主作者将该文档共享给以下人员:
- 所有共同作者
- 你(他们的写作伙伴)
- 理想情况下,还应包括一位博客团队中指定的负责人。
作为写作伙伴,你需要阅读草稿内容,并直接提出建议或以其他方式提供反馈。 博客文章的作者通常也会反过来成为你的写作伙伴, 因此他们会针对你所撰写的文章草稿提供类似的反馈。
你的角色是推荐最小的修改集,以使文章适合发布。如果某个图表完全无法理解, 或者文字表达非常不清晰,请提供反馈。如果你对措辞或标点符号有轻微的不同意见, 请忽略它。只要符合博客指南, 让文章作者以他们自己的风格写作即可。
在此完成后,主作者将发起一个 PR 并使用 Markdown 提交文章。 然后你可以提供审阅意见。
一些作者更喜欢从协同编辑开始, 而另一些人则喜欢直接进入 GitHub。
无论他们选择哪种方式,你的角色是提供反馈,使博客团队能够轻松完成审核, 并确认文章可以作为草稿合并。有关作者需要完成的操作, 请参阅向 Kubernetes 博客提交文章。
使用 GitHub 的建议功能指出需要修改的地方。
一旦 Markdown 文件和其他内容(例如图片)看起来没有问题, 你就可以提供正式的审阅意见。
审阅 PR
遵循**审阅 PR **一文的博客部分所给的要求。
当你认为所发起的博客 PR 足够好可以合并时,在 PR 中添加 /lgtm
评论。
这一注释向仓库自动化工具(Prow)内容申明内容“在我看来没有问题”。
Prow 会推进相关流程。/lgtm
命令允许你将自己的意见公开出来,
无论你是否正式成为 Kubernetes 项目的一员。
你或文章作者应通知博客团队有文章已准备好进行签发。根据提交指南,
文章前面应已标记为 draft: true
。
后续步骤
作为写作伙伴,没有第四步。一旦 PR 准备好合并, 博客团队(或者,对于贡献者网站,贡献者通信团队)将会接手。 根据反馈,你可能需要返回到前面的步骤,但通常你可以认为作为伙伴的工作已经完成。
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.