本文发布已超过一年。较旧的文章可能包含过时内容。请检查页面中的信息自发布以来是否已过时或不准确。

文档如何处理第三方和双源内容

编者按:Zach 是 Kubernetes 文档特别兴趣小组 (SIG Docs) 的主席之一。

去年夏末,SIG Docs 就 Kubernetes 文档中的第三方内容发起了一场社区讨论。这场讨论形成了一个 Kubernetes 增强提案 (KEP),经过五个月的审查和评论,SIG Architecture 批准了该 KEP,将其作为 Kubernetes 文档的内容指南

以下是 Kubernetes 文档现在如何处理第三方内容:

始终允许链接到 Kubernetes 项目中的活跃内容(位于 kubernetes 和 kubernetes-sigs GitHub 组织下的项目)。

Kubernetes 的运行需要一些第三方内容。示例包括容器运行时(containerd、CRI-O、Docker)、网络策略(CNI 插件)、Ingress 控制器和日志记录。

如果 Kubernetes 的运行需要,文档可以链接到 Kubernetes 项目之外的第三方开源软件 (OSS)。

这些常识性指导方针确保 Kubernetes 文档只记录 Kubernetes 本身。

保持文档聚焦

我们的目标是让 Kubernetes 文档成为关于 Kubernetes 功能的值得信赖的指南。为了实现这一目标,SIG Docs 正在追踪第三方内容,并移除任何既不在 Kubernetes 项目中也非 Kubernetes 运行所必需的第三方内容。

内容重定向

一些读者可能觉得有用的内容将被移除。为确保读者能持续获取信息,我们正在给予利益相关者时间,直到1.19 文档发布截止日期,即 2020 年 7 月 9 日,以便将计划移除的内容重定向到其他位置。

在接下来的几个月里,随着贡献者提交移除内容的 PR,你将看到文档中的第三方内容减少。

背景

随着时间的推移,SIG Docs 注意到文档中厂商内容不断增加。一些内容是厂商特定的实现,并非 Kubernetes 在项目内运行所必需的。其他内容是包装得很巧妙的广告,几乎没有或根本没有功能内容。一些厂商内容是新增的;另一些内容已经在文档中存在多年。很明显,文档需要清晰、界限分明的指导方针来规定哪些类型的第三方内容允许或不允许出现。内容指南就是在社区广泛审查和评论后产生的。

文档在准确、有用、值得信赖并始终聚焦功能时效果最佳。根据我们的经验,厂商内容会稀释信任度和准确性。

简单来说:功能文档不是厂商宣传产品的地方。我们的内容政策旨在让文档专注于帮助开发者和集群管理员,而非市场营销。

双源内容

影响较小但同样重要的是 Kubernetes 文档如何处理双源内容。双源内容是指在多个位置发布的内容,或来自非规范源的内容。

摘自Kubernetes 内容指南

在可能的情况下,Kubernetes 文档链接到规范源,而不是托管双源内容。

最大限度地减少双源内容可以简化文档,并使网络上的内容更容易被搜索。我们也在努力整合和重定向 Kubernetes 文档中的双源内容。

贡献方式

我们正在Kubernetes 网站仓库的一个 issue 中追踪第三方内容。如果你发现非项目内且非 Kubernetes 运行所必需的第三方内容,请在该追踪 issue 下评论。

一旦你发现了不符合规定的内容,欢迎随时提交 PR 移除它!

想了解更多?

更多信息,请阅读追踪第三方内容的 issue 描述。