Edit This Page

为 Kubernetes 文档做贡献

如果你想帮助对 Kubernetes 文档或网站做出贡献，我们很高兴得到你的帮助！ 任何人都可以做出贡献，无论你刚参与项目还是参与了很长时间，无论你是开发人员还是用户，或是无法忍受看到拼写错误的人。

更多途径参与 Kubernetes 社区或了解我们，请访问 Kubernetes 社区网站。

查找 样式指南 或者 Kubernetes 社区网站？

贡献者类型

  • 签署了 CLA并为项目贡献了时间和精力的 Kubernetes 组织的_成员_。 参见 社区成员 中对于成员资格的具体标准。
  • SIG Docs 的_评审者_是对评审文档 PR 感兴趣，并被 SIG Docs 审批者添加到 Github 群组并在 Github 仓库中 OWNERS 文件的 Kubernetes 组织的成员。
  • SIG Docs 的_审批者_是对项目持续贡献，并被授予合并 PR 权限和代表 Kubernetes 组织发布内容的成员。 批准人也可以在更广泛的 Kubernetes 社区中代表 SIG Docs 团队。 SIG Docs审批者的一些职责，如协调发布版本，需要大量的时间投入。

贡献途径

以下列表将工作分成了：任何人都可以做的工作、Kubernetes 组织成员可以做的工作，和熟悉 SIG Docs 流程并且有更高访问权限才能做的工作。 持续的贡献可以帮助你理解已有的工具和组织决策。

你对 Kubernetes 文档可以做出的贡献不仅限于列表列出的条目，但它可以帮助你开动起来。

  • 成员
    • 完善已有文档
    • 在 Slack 或 SIG Docs 邮件列表中提出改进意见
    • 提升文档的易用性
    • 对 PR 提出无约束的反馈
    • 编写博文和案例分析
  • 评审者
    • 为新功能特性编写文档
    • 对 issue 进行筛选和分类
    • 评审 PR
    • 创建图表、图形分析和嵌入式的屏幕/视频
    • 本地化
    • 作为 docs 小组的代表为其他项目仓库做贡献
    • 在代码中编辑面向用户的字符串
    • 改进代码注释和 Godoc
  • 审批者
    • 通过批准和合并 PR 发布贡献成果
    • 作为 docs 团队的代表参与 Kubernetes 发布团队
    • 对样式指南提出改进建议
    • 对文档测试提出改进建议
    • 对 Kubernetes 网站或其他工具提出改进建议

其他贡献途径

  • 如果您要通过 Twitter 或 Stack Overflow 等在线论坛为社区做贡献，或了解本地会议及 Kubernetes 事件，请查看 Kubernetes 社区网站.
开始贡献

中级贡献

高级贡献

参考文档概述

文档风格概述

参与 SIG Docs

本地化 Kubernetes 文档