建议内容改进

如果您发现 Kubernetes 文档存在问题或有新内容的想法，请打开一个问题。您只需要一个 GitHub 帐户 和一个网页浏览器。

在大多数情况下，Kubernetes 文档的新工作始于 GitHub 中的一个问题。Kubernetes 贡献者会根据需要审查、分类和标记问题。接下来，您或 Kubernetes 社区的其他成员会打开一个包含更改的拉取请求以解决该问题。

打开问题

如果您想建议改进现有内容或发现错误，请打开一个问题。

1. 点击右侧边栏上的“创建问题”链接。这将重定向到一个预先填充了一些标题的 GitHub 问题页面。
2. 描述问题或改进建议。提供尽可能多的细节。
3. 点击“提交新问题”。

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

建议新内容

如果您有新内容的想法，但不知道应该放在哪里，您仍然可以提交问题。要么

• 在您认为内容所属的章节中选择一个现有的页面，然后点击“创建问题”。
• 转到 GitHub 并直接提交问题。

如何提交出色的问题

提交问题时请牢记以下几点

• 提供清晰的问题描述。描述具体缺少什么、过时、错误或需要改进。
• 解释问题对用户造成的影响。
• 将给定问题的范围限制在合理的单位工作中。对于范围较大的问题，将其分解成更小的问题。例如，“修复安全文档”过于宽泛，但“在“限制网络访问”主题中添加详细信息”足够具体，可以执行。
• 搜索现有问题以查看是否有任何与新问题相关或类似的问题。
• 如果新问题与另一个问题或拉取请求相关，请使用其完整 URL 或以 # 字符为前缀的问题或拉取请求编号来引用它。例如，由 #987654 引入。
• 遵循 行为准则。尊重您的同事贡献者。例如，“文档很糟糕”不是有益或礼貌的反馈。