建议内容改进
如果您发现 Kubernetes 文档有问题或对新内容有任何想法,请提交问题。您只需要一个 GitHub 帐户 和一个网络浏览器。
在大多数情况下,Kubernetes 文档的新工作始于 GitHub 上的一个问题。然后,Kubernetes 贡献者会根据需要审查、分类和标记问题。接下来,您或 Kubernetes 社区的另一个成员会打开一个拉取请求,其中包含解决该问题的更改。
打开问题
如果您想建议改进现有内容或注意到错误,请提交问题。
- 点击右侧边栏上的“创建问题”链接。这会将您重定向到一个预先填充了一些标题的 GitHub 问题页面。
- 描述问题或改进建议。尽可能提供更多详细信息。
- 点击“提交新问题”。
提交后,请偶尔查看您的问题或打开 GitHub 通知。审查者和其他社区成员可能会在对您的问题采取行动之前提出问题。
建议新内容
如果您有新内容的想法,但不确定它应该放在哪里,您仍然可以提交问题。您可以:
- 选择您认为内容所属部分的现有页面,然后点击“创建问题”。
- 转到 GitHub 并直接提交问题。
如何提交好的问题
提交问题时请记住以下几点:
- 提供清晰的问题描述。描述具体缺少什么、过时了什么、错误了什么或需要改进什么。
- 解释问题对用户的具体影响。
- 将给定问题的范围限制在合理的工作单元内。对于范围较大的问题,请将其分解为较小的问题。例如,“修复安全文档”过于宽泛,但“在‘限制网络访问’主题中添加详细信息”则足够具体,可以采取行动。
- 搜索现有问题,看看是否有任何与新问题相关或相似的问题。
- 如果新问题与另一个问题或拉取请求相关,请使用其完整 URL 或在其问题或拉取请求编号前加上“
#
”字符来引用它。例如,“由 #987654 引入
”。 - 遵守 行为准则。尊重您的贡献者同伴。例如,“文档很糟糕” bukanlah 反馈 yang 有帮助 atau sopan。
上次修改时间:2023 年 7 月 12 日太平洋标准时间上午 1:25:修改文档主页 (9520b96a61)