这些指南涵盖了主要的 Kubernetes 博客和 Kubernetes 贡献者博客。
所有博客内容还必须遵守内容指南中的总体政策。
请确保你熟悉为 Kubernetes 博客做贡献的入门部分,不仅是为了了解这两个官方博客及其区别,也是为了获得流程的概览。
Kubernetes 项目仅接受原创内容,且必须为英文。
如果内容已在 Kubernetes 项目之外提交或发布,Kubernetes 项目将无法接受该博客内容。
官方博客不可作为将第三方现有内容转用为新内容的媒介。
此限制甚至延伸到推广其他 Linux 基金会和 CNCF 项目。许多 CNCF 项目都有自己的博客。即使该项目是专门为与 Kubernetes(或 Linux 等)配合使用而设计的,这些博客通常也是发布特定项目相关文章的更好选择。
文章内容必须广泛适用于 Kubernetes 社区。例如,提交的内容应关注上游 Kubernetes,而不是厂商特定的配置。对于提交给主博客且非镜像文章的内容,文章中的超链接通常应指向官方 Kubernetes 文档。进行外部引用时,链接应当多样化——例如,提交的内容不应仅包含指向同一家公司博客的链接。
官方 Kubernetes 博客不是投放厂商广告的地方,也不适合发布推广 Kubernetes 之外特定解决方案的文章。
有时这是一种微妙的平衡。你可以在 Slack(#sig-docs-blog)中咨询某篇文章是否适合在 Kubernetes 博客和/或贡献者博客上发布——请随时与我们联系。
内容指南无条件适用于博客文章及其相关的 PR。请记住,指南中的某些限制明确说明仅与文档相关;那些标记的限制不适用于博客文章。
本网站已本地化为多种语言;英语是所有其他本地化版本的“上游”。即使你掌握其他语言并乐意提供本地化版本,也应在单独的 pull request 中进行(请参阅每个 PR 的语言)。
你必须撰写原创内容,且必须拥有将该内容授权给云原生计算基金会(CNCF)的许可(以便 Kubernetes 项目能合法发布它)。这意味着不仅禁止直接剽窃,如果你没有权限满足 CNCF 版权许可条件(例如,你的雇主有关于知识产权的政策限制了你的行为),你也不能撰写博客文章。
博客的许可证允许出于商业目的使用该内容,但反之则不然。
与参与 Kubernetes SIG 活动或其成果相关的主题始终属于讨论范畴(请参阅贡献者通讯团队以获取此类文章的支持)。
项目通常会将这些文章镜像到两个博客中。
Kubernetes 网站持有中国政府颁发的互联网内容提供商 (ICP) 许可证。虽然不太可能出现问题,但 Kubernetes 不能发布会被中国政府官方互联网内容过滤系统拦截的文章。
除了通用的风格指南外,博客文章应(而非必须)与博客特定的风格建议保持一致。
本页面的其余部分是额外指南;这些不是文章必须严格遵守的规则,但审核员很可能会(也应该)要求对明显不符合此处建议的文章进行修改。
对于插图——包括图表或图示——请尽可能使用 figure 短代码。出于无障碍访问考虑,你应该设置 alt 属性。
插图、技术图表和类似图形请使用矢量图;强烈建议使用 SVG 格式。
使用位图进行插图的文章维护难度较大,在某些情况下,博客团队可能会要求作者在发布前修改文章。
博客文章应力求面向未来
以下是一些适合主 Kubernetes 博客的内容示例:
以下是一些适合 Kubernetes 贡献者博客的内容示例:
但是,项目不会发布: