14 KiB
| content_type | title | weight | card | ||||||
|---|---|---|---|---|---|---|---|---|---|
| concept | 为 Kubernetes 文档出一份力 | 09 |
|
本网站由 Kubernetes SIG Docs（文档特别兴趣小组）维护。 Kubernetes 项目欢迎所有贡献者（无论是新手还是经验丰富的贡献者）提供帮助！
Kubernetes 文档项目的贡献者：
- 改进现有内容
- 创建新内容
- 翻译文档
- 管理并发布 Kubernetes 周期性发行版的文档
{{< note >}}
要了解有关为 Kubernetes 做出贡献的更多信息， 请参阅贡献者文档。 {{< /note >}}
入门
任何人都可以提出文档方面的问题（issue），或贡献一个变更，用拉取请求（PR）的方式提交到
GitHub 上的 kubernetes/website 仓库。
当然你需要熟练使用 git 和 GitHub
才能在 Kubernetes 社区中有效工作。
如何参与文档编制：
{{< mermaid >}}
flowchart TB
subgraph third[发起 PR]
direction TB
U[ ] -.-
Q[改进现有内容] --- N[创建新内容]
N --- O[翻译文档]
O --- P[管理并发布 K8s
周期性发行版的文档]
end
subgraph second[评审]
direction TB
T[ ] -.-
D[仔细查看
kubernetes/website
仓库] --- E[下载安装 Hugo
静态站点
生成器]
E --- F[了解基本的
GitHub 命令]
F --- G[评审待处理的 PR
并遵从变更审查
流程]
end
subgraph first[注册]
direction TB
S[ ] -.-
B[签署 CNCF
贡献者
许可协议] --- C[加入 sig-docs
Slack 频道]
C --- V[加入 kubernetes-sig-docs
邮件列表]
V --- M[参加每周的
sig-docs 电话会议
或 slack 会议]
end
A([fa:fa-user 新的
贡献者]) --> first
A --> second
A --> third
A --> H[提出问题!!!]
classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px; classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000 class A,B,C,D,E,F,G,H,M,Q,N,O,P,V grey class S,T,U spacewhite class first,second,third white {{</ mermaid >}}
图 1. 新手入门指示。
图 1 概述了新贡献者的路线图。 你可以遵从“注册”和“评审”所述的某些或全部步骤。 至此，你完成了发起 PR 的准备工作， 可以通过“发起 PR” 列出的事项实现你的贡献目标。 再次重申，欢迎随时提出问题！
有些任务要求 Kubernetes 组织内更高的信任级别和访问权限。 阅读参与 SIG Docs 工作，获取角色和权限的更多细节。
第一次贡献
你可以提前查阅几个步骤，来准备你的第一次贡献。 图 2 概述了后续的步骤和细节。
{{< mermaid >}}
flowchart LR
subgraph second[第一次贡献]
direction TB
S[ ] -.-
G[查阅其他 K8s
成员发起的 PR] -->
A[检索 kubernetes/website
问题列表是否有
good first 一类的 PR] --> B[发起一个 PR!!]
end
subgraph first[建议的准备工作]
direction TB
T[ ] -.-
D[阅读贡献概述] -->E[阅读 K8s 内容
和风格指南]
E --> F[了解 Hugo 页面
内容类型
和短代码]
end
first ----> second
classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px; classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000 class A,B,D,E,F,G grey class S,T spacewhite class first,second white {{</ mermaid >}}
图 2. 第一次贡献的准备工作。
- 通读贡献概述，了解参与贡献的不同方式。
- 查看
kubernetes/website问题列表， 检索最适合作为切入点的问题。 - 在现有文档上，使用 GitHub 提交 PR， 掌握在 GitHub 上登记 Issue 的方法。
- Kubernetes 社区其他成员会评审 PR， 以确保文档精准和语言流畅。
- 阅读 kubernetes 的内容指南和 风格指南，以发表有见地的评论。
- 了解页面内容类型和 Hugo 短代码。
贡献时获取帮助
做出第一个贡献可能会让人感觉比较困难。
新贡献者大使
将引导你完成最初的一些贡献。你可以在 Kubernetes Slack
中联系他们，最好是在 #sig-docs 频道中。还有每月第一个星期二举行的
新贡献者见面会，
你可以在此处与新贡献者大使互动并解决你的疑问。
下一步
参与 SIG Docs 工作
SIG Docs 是负责发布、维护 Kubernetes 文档的贡献者团体。 参与 SIG Docs 是 Kubernetes 贡献者（开发者和其他人员）对 Kubernetes 项目产生重大影响力的好方式。
SIG Docs 的几种沟通方式：
- 加入 Kubernetes 在 Slack 上的
#sig-docs频道。 一定记得自我介绍! - 加入
kubernetes-sig-docs邮件列表， 这里有更广泛的讨论，和官方决策的记录。 - 参加每两周召开一次的 SIG Docs 视频会议。
会议总是在
#sig-docs上发出公告，同时添加到 Kubernetes 社区会议日历。 你需要下载 Zoom 客户端软件，或电话拨号接入。 - 如果有几周未召开实况 Zoom 视频会议，请参加 SIG Docs 异步 Slack 站会。
会议总是在
#sig-docs上发出公告。 你可以在会议公告后 24 小时内为其中任一议题做贡献。
其他贡献方式
- 访问 Kubernetes 社区网站。 参与 Twitter 或 Stack Overflow，了解当地的 Kubernetes 会议和活动等等。
- 阅读贡献者备忘单， 参与 Kubernetes 功能开发。
- 访问贡献者网站，进一步了解有关 Kubernetes 贡献者 和更多贡献者资源的信息。
- 提交一篇博客文章或案例研究。