本文发布已超过一年。较旧的文章可能包含过时的内容。请检查页面中的信息自发布以来是否已变得不正确。
文档如何处理第三方和双来源内容
编者注: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 控制器和日志记录。
如果第三方开源软件 (OSS) 对于 Kubernetes 运行是必需的,则文档可以链接到 Kubernetes 项目之外的该软件。
这些常识性指南确保 Kubernetes 文档记录的是 Kubernetes。
保持文档的重点
我们的目标是让 Kubernetes 文档成为 Kubernetes 功能的可靠指南。为了实现这一目标,SIG Docs 正在跟踪第三方内容,并删除任何不在 Kubernetes 项目且不是 Kubernetes 运行所必需的第三方内容。
重新安置内容
一些内容将被删除,但读者可能会觉得有用。为了确保读者可以持续访问信息,我们为利益相关者设定了截止日期:1.19 版本文档的截止日期,即 2020 年 7 月 9 日,在此之前,请重新安置任何计划删除的内容。
在接下来的几个月中,您会看到文档中的第三方内容减少,因为贡献者会打开 PR 来删除内容。
背景
随着时间的推移,SIG Docs 观察到文档中的供应商内容越来越多。一些内容采取了供应商特定实现的形式,这些实现不是 Kubernetes 在项目中运行所必需的。其他内容则是伪装成广告的,几乎没有功能内容。一些供应商内容是新的,而其他内容已经在文档中存在多年。很明显,文档需要明确、界限清晰的指南,说明允许和不允许哪种类型的第三方内容。内容指南是在社区进行广泛审查和评论后产生的。
当文档准确、有帮助、值得信赖并专注于功能时,效果最佳。根据我们的经验,供应商内容会降低信任度和准确性。
简而言之:功能文档不是供应商宣传其产品的地方。我们的内容政策使文档专注于帮助开发人员和集群管理员,而不是营销。
双源内容
Kubernetes 文档如何处理双源内容,其影响较小但也很重要。双源内容是在多个位置或从非规范来源发布的内容。
在可能的情况下,Kubernetes 文档链接到规范来源,而不是托管双源内容。
最大限度地减少双源内容可以简化文档,并使 Web 上的内容更易于搜索。我们也在努力整合和重定向 Kubernetes 文档中的双源内容。
贡献方式
我们正在Kubernetes 网站存储库中的一个 issue中跟踪第三方内容。如果您看到项目之外且不是 Kubernetes 运行所必需的第三方内容,请在该跟踪 issue 上发表评论。
一旦您确定了不符合标准的内容,请随意打开 PR 来删除它!
想了解更多?
有关更多信息,请阅读跟踪第三方内容的 issue 描述。