建议内容改进

如果您发现 Kubernetes 文档有问题或有新内容的想法，请创建一个 issue。您只需要一个 GitHub 账户 和一个网页浏览器。

在大多数情况下，Kubernetes 文档的新工作始于 GitHub 上的一个 issue。然后，Kubernetes 贡献者会根据需要进行审查、分类和标记 issue。接下来，您或其他 Kubernetes 社区成员将打开一个 pull request 来更新内容以解决该 issue。

创建 issue

如果您想改进现有内容或发现错误，请创建一个 issue。

1. 点击右侧边栏的 “Create an issue” 链接。这会将您重定向到一个已预先填充了一些标题的 GitHub issue 页面。
2. 描述您发现的问题或改进建议。请提供尽可能多的详细信息。
3. 点击 “Submit new issue”。

提交后，请偶尔查看您的 issue，或开启 GitHub 通知。审阅者和其他社区成员在采取行动之前可能会提出问题。

建议新内容

如果您有新内容的想法，但不确定它应该放在哪里，仍然可以提交一个 issue。您可以：

• 选择您认为内容所属部分中的一个现有页面，然后点击 “Create an issue”。
• 直接访问 GitHub 并提交 issue。

如何创建高质量的 issue

在创建 issue 时，请牢记以下几点：

• 提供清晰的 issue 描述。具体说明哪些内容缺失、过时、错误或需要改进。
• 解释该 issue 对用户产生的具体影响。
• 将一个 issue 的范围限制在一个合理的工作单元内。对于范围较大的问题，请将其分解为更小的 issue。例如，“修复安全文档”过于宽泛，而“为‘限制网络访问’主题添加详细信息”则足够具体，可以操作。
• 搜索现有 issue，查看是否有与新 issue 相关或相似的内容。
• 如果新 issue 与其他 issue 或 pull request 相关，请通过其完整 URL 或带有 # 前缀的 issue 或 pull request 编号来引用。例如：Introduced by #987654。
• 遵守 行为准则。尊重您的社区贡献者。例如，“文档太糟糕了”不是一个有用或礼貌的反馈。