提出内容改进建议

    在大多数情况下,Kubernetes 文档的新工作都是开始于 GitHub 上的某个问题。 Kubernetes 贡献者会审阅这些问题并根据需要对其分类、打标签。 接下来,你或者别的 Kubernetes 社区成员就可以发起一个带有变更的拉取请求, 以解决这一问题。

    1. 点击右侧边栏的 提交文档问题 按钮。浏览器会重定向到一个 GitHub 问题页面, 其中包含了一些预先填充的内容。
    2. 点击 Submit new issue

    提交之后,偶尔查看一下你所提交的问题,或者开启 GitHub 通知。 评审人(reviewers)和其他社区成员可能在针对所提问题采取行动之前,问一些问题。

    • 在预期的节区中选择一个现有页面,点击 提交文档问题
    • 前往 GitHub Issues 页面, 直接记录问题。

    在记录问题时,请注意以下事项:

    • 提供问题的清晰描述,描述具体缺失的内容、过期的内容、错误的内容或者需要改进的文字。
    • 将给定问题的范围限定在一个工作单位范围内。如果问题牵涉的领域较大,可以将其分解为多个小一点的问题。 例如:”Fix the security docs” 是一个过于宽泛的问题,而 “Add details to the ‘Restricting network access’ topic” 就是一个足够具体的、可操作的问题。
    • 搜索现有问题的列表,查看是否已经有相关的或者类似的问题已被记录。
    • 如果新问题与某其他问题或 PR 有关联,可以使用其完整 URL 或带 字符的 PR 编号来引用之。 例如:Introduced by #987654
    • 遵从行为准则。尊重同行贡献者。 例如,”The docs are terrible” 就是无用且无礼的反馈。