建议改进内容

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

在大多数情况下,Kubernetes 文档的新工作始于 GitHub 中的一个议题。然后 Kubernetes 贡献者根据需要审阅、分类和标记议题。接下来,您或 Kubernetes 社区的另一成员将开启一个拉取请求,其中包含用于解决该议题的更改。

开启议题

如果您想建议改进现有内容或注意到错误,请开启一个议题。

  1. 点击右侧边栏中的创建议题链接。这会将您重定向到已预填充了一些标题的 GitHub 议题页面。
  2. 描述议题或改进建议。尽可能提供详细信息。
  3. 点击提交新议题

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

建议新内容

如果您有新内容的想法,但不确定应该放在哪里,您仍然可以提交议题。可以采取以下任一方法:

  • 选择您认为内容所属部分中的现有页面,然后点击创建议题
  • 前往 GitHub 直接提交议题。

如何提交出色的议题

提交议题时请记住以下几点

  • 提供清晰的议题描述。详细说明具体缺少什么、过时、错误或需要改进的地方。
  • 解释该议题对用户的具体影响。
  • 将给定议题的范围限制在合理的工作单元内。对于范围较大的问题,将其分解为较小的议题。例如,“修复安全文档”太宽泛,但“在‘限制网络访问’主题中添加详细信息”则足够具体,以便采取行动。
  • 搜索现有议题,查看是否有与新议题相关或相似的内容。
  • 如果新议题与另一个议题或拉取请求相关,请通过其完整 URL 或以 # 字符为前缀的议题或拉取请求编号来引用它。例如,Introduced by #987654
  • 遵守行为准则。尊重您的其他贡献者。例如,“文档太糟糕了”不是有帮助或礼貌的反馈。
上次修改时间:2025 年 3 月 13 日太平洋标准时间 10:41:添加博客贡献指南 (815a75d025)