本文发表于一年多前。旧文章可能包含过时内容。请检查页面中的信息自发布以来是否已变得不正确。

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

编者按: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 说明。