博客指南

这些指南涵盖了主要的 Kubernetes 博客和 Kubernetes 贡献者博客。

所有博客内容还必须遵守 内容指南中的总体政策。

准备工作

请确保您熟悉 为 Kubernetes 博客投稿的介绍部分,这不仅能让您了解两个官方博客及其差异,还能对整个流程有一个概览。

原创内容

Kubernetes 项目仅接受英文的原创内容

此限制甚至延伸到推广其他 Linux Foundation 和 CNCF 项目。许多 CNCF 项目都有自己的博客。对于关于特定项目的帖子,这些博客通常是更好的选择,即使该项目专门设计用于与 Kubernetes(或 Linux 等)协同工作。

相关内容

文章必须包含广泛适用于 Kubernetes 社区的内容。例如,提交的文章应侧重于上游 Kubernetes,而不是特定于供应商的配置。对于提交给主博客但不是 镜像文章的文章,文章中的超链接通常应指向官方 Kubernetes 文档。在进行外部引用时,链接应多样化——例如,提交的内容不应仅包含指向同一公司博客的链接。

官方 Kubernetes 博客不是用于供应商宣传或推广 Kubernetes 外部特定解决方案的文章的地方。

有时这是一个微妙的平衡。您可以在 Slack (#sig-docs-blog) 中询问有关帖子是否适合 Kubernetes 博客和/或贡献者博客的指导——请随时联系。

内容指南》无条件适用于博客文章及其添加它们的 PR。请注意,指南中的某些限制声明仅与文档相关;这些标记的限制不适用于博客文章。

本地化

该网站已本地化为多种语言;英语是所有其他本地化的“上游”。即使您会说其他语言并乐意提供本地化,也应在单独的 PR 中进行(请参阅 每个 PR 的语言)。

您必须撰写原创内容,并且您必须获得许可才能将该内容授权给 Cloud Native Computing Foundation(以便 Kubernetes 项目能够合法发布它)。这意味着不仅禁止直接抄袭,如果您没有获得满足 CNCF 版权许可条件的许可(例如,如果您的雇主有关于知识产权的政策限制了您的行为),您就不能撰写博客文章。

博客的许可证允许出于商业目的的商业使用内容,但反之则不行。

特别兴趣小组和工作组

与 Kubernetes SIG 活动的参与或结果相关的议题总是切题的(请参阅 贡献者沟通团队中的工作以支持这些帖子)。

项目通常会将这些文章镜像到两个博客。

国家内容限制

Kubernetes 网站拥有中国政府颁发的互联网内容提供商 (ICP) 许可证。虽然不太可能成为问题,但 Kubernetes 不能发布会被中国政府官方审查的互联网内容所阻止的文章。

特定于博客的内容指南

除了通用的风格指南外,博客文章还应该(而不是必须)符合特定于博客的风格建议

本页的其余部分是补充指南;这些不是文章必须遵循的严格规则,但审阅者可能会(并且应该)要求修改明显不符合此处建议的文章。

图表和插图

对于插图——包括图表或图形——如果可行,请使用 figure shortcode。为了可访问性,您应该设置一个 `alt` 属性。

请为插图、技术图表和类似图形使用矢量图像;强烈推荐 SVG 格式。

使用光栅图像作为插图的文章更难维护,在某些情况下,博客团队可能会要求作者在发布前修改文章。

时效性

博客文章应旨在具有前瞻性

  • 鉴于项目的开发速度,SIG Docs 倾向于时效性的写作:内容无需更新即可保持对读者的准确性。
  • 添加教程或更新官方文档可能比写一篇高层概述作为博客文章更好的选择。
  • 考虑将长篇技术内容集中在博客文章的号召性用语中,并专注于问题领域或读者为什么应该关心。

内容示例

以下是一些适合主要 Kubernetes 博客的内容示例

  • 关于新的 Kubernetes 功能的公告
  • 关于如何使用 Kubernetes 实现某个目标的解释;例如,告诉我们您在滚动部署基本理念上的低耗时改进
  • 比较几种与 Kubernetes 和云原生相关的不同软件选项。链接到其中一个选项是可以的,只要您完全披露您的利益冲突/关系。
  • 关于问题或事件以及如何解决它们的故事
  • 讨论为特定用例构建云原生平台的文章
  • 您对 Kubernetes 的优缺点的看法
  • 关于非核心 Kubernetes 的公告和故事,例如 Gateway API
  • 发布后公告和更新
  • 关于重要的 Kubernetes 安全漏洞的消息
  • Kubernetes 项目更新
  • 教程和指南
  • 关于 Kubernetes 和云原生的思想领导力
  • Kubernetes 的组件是模块化的,因此撰写关于现有集成点(如 CNI 和 CSI)的文章是相关的。前提是您不写供应商宣传,您也可以写关于这些集成另一端的内容。

以下是一些适合 Kubernetes 贡献者博客的内容示例

  • 关于如何测试您对 Kubernetes 代码的更改的文章
  • 关于非代码贡献的内容
  • 讨论设计仍在讨论中的 Alpha 功能
  • 关于工作组、特别兴趣小组等的“认识团队”文章
  • 关于如何编写安全代码以成为 Kubernetes 本身一部分的指南
  • 关于维护者峰会及其成果的文章

不接受的内容示例

然而,项目将不发布

  • 供应商宣传
  • 您已在其他地方发布过的文章,即使只是发布到您自己的低流量博客
  • 大量示例源代码,只有很少的解释
  • 关于与 Kubernetes 协作或依赖 Kubernetes 的外部项目的更新(请将其发布到外部项目自己的博客上)
  • 关于将 Kubernetes 与特定云提供商一起使用的文章
  • 批评特定个人、群体或企业的文章
  • 包含重要的技术错误或误导性细节的文章(例如:如果您建议关闭生产集群中的重要安全控制,因为它可能不方便,Kubernetes 项目很可能会拒绝该文章)。
最后修改时间:2025 年 3 月 13 日上午 10:41 PST:添加博客贡献指南(815a75d025)