文档内容指南

    如果你不清楚哪些事情是可以做的,请加入到 的 频道提问! 你可以在 http://slack.k8s.io 注册到 Kubernetes Slack。

    关于为 Kubernetes 文档创建新内容的更多信息,可参考 。

    Kubernetes 网站(包括其文档)源代码位于 kubernetes/website 仓库中。

    只有当以下条件满足时,Kuberentes 文档才允许第三方项目的内容:

    • 内容所描述的软件在 Kubernetes 项目内
    • 内容所描述的软件不在 Kubernetes 项目内,却是让 Kubernetes 正常工作所必需的

    Kubernetes 文档包含 Kubernetes 项目下的多个项目的应用示例。 这里的 Kubernetes 项目指的是 和 kubernetes-sigs GitHub 组织 下的项目。

    链接到 Kubernetes 项目中活跃的内容是一直允许的。

    只有对应的第三方开源软件(OSS)是运行 Kubernetes 所必需的,才可以在文档中包含 指向这些 Kubernetes 项目之外的软件的链接。

    只要有可能,Kubernetes 文档应该指向标准典型的信息源而不是直接托管多重来源的内容。

    双重来源的内容需要双倍(甚至更多)的投入才能维护,而且通常很快就会变得停滞不前。

    如果你对允许出现的内容有疑问,请加入到 的 频道提问!