From b174ac547617770330a967e42dc31b5f96747897 Mon Sep 17 00:00:00 2001 From: Hongcai Ren Date: Sun, 22 Sep 2019 18:53:22 +0800 Subject: [PATCH] [zh]Translate contribute/participating.md (#16375) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Translate participating.md from content/en/docs/contribute/participating.md * 修复注释块 --- content/zh/docs/contribute/participating.md | 518 ++++++++++++++++++++ 1 file changed, 518 insertions(+) create mode 100644 content/zh/docs/contribute/participating.md diff --git a/content/zh/docs/contribute/participating.md b/content/zh/docs/contribute/participating.md new file mode 100644 index 0000000000..dce311e537 --- /dev/null +++ b/content/zh/docs/contribute/participating.md @@ -0,0 +1,518 @@ +--- +title: 参与到 SIG Docs +content_template: templates/concept +card: + name: contribute + weight: 40 +--- + +{{% capture overview %}} + + +SIG Docs 是 Kubernetes 项目中的一个 [special interest groups](https://github.com/kubernetes/community/blob/master/sig-list.md), +总的来说,它负责编写、更新和维护 Kubernetes 文档。 + + +SIG Docs 欢迎所有贡献者提供内容和检视。任何人可以提交拉取请求(PR), +欢迎对文档内容提交 issue 和 对正在进行中的 PR 进行评论。 + + +在 SIG Docs,你可以成为 [member](#members)、[reviewer](#reviewers) 或者 [approver](#approvers)。 +这些角色拥有更高的权限,并且需要承担批准和提交更改的责任。 +有关Kubernetes社区中的成员如何工作的更多信息,请参见[community-membership](https://github.com/kubernetes/community/blob/master/community-membership.md)。 +本文档的其余部分概述了这些角色在 SIG Docs 中发挥作用的一些独特方式, +SIG Docs 负责维护 Kubernetes 最面向公众的方面之一—— Kubernetes 网站和文档。 +{{% /capture %}} + +{{% capture body %}} + + +## 角色和责任 + + + +当一个 pull 请求被合并到用于发布内容的分支(当前为“master”),该内容将发布并向全世界开放。 +为了确保发布内容的质量较高,每个 pull 请求需要 SIG Docs 的 approver 审批。 +它是这样工作的。 + + +- 当某个 pull request 拥有 `lgtm` 和 `approve` 标签, 并且没有 `hold` 标签时,这个 pull request 会自动合入。 +- Kubernetes 组织成员 和 SIG Docs 的 approvers 可以通过评论的方式阻止某个 pull request 自动合入(评论中包含 `/hold` 或 取消 `/lgtm` 的内容)。 +- 任何 Kubernetes 成员都可以通过在评论回复 `/lgtm` 来增加 `/lgtm` 标签。 +- 只有 SIG Docs 的 approver 可以在评论中回复 `/approve` 并触发合并。 + 某些 approver 还兼具其他角色,比如 [PR Wrangler](#pr-wrangler) 或 [SIG Docs chairperson](#sig-docs-chairperson)。 + + +关于 Kubernetes 组织成员和 SIG Docs approver 的区别,请参考 [Types of contributor](/docs/contribute#types-of-contributor)。 +以下部分将详细介绍这些角色及其内部的工作方式。 + +### Anyone + + +任何人可以针对 Kubernetes 的任何内容(包括文档)提交 issue。 + + +任何人想到提交 pull request,必须要签署 CLA。 否则 ubernetes 项目则不能接受你的贡献。 + +### Members + + +任何 [Kubernetes 组织成员](https://github.com/kubernetes) 都可以检视 pull request。 +SIG Docs 组成员经常需要检视来自其他 SIG 的 pull request,以确保技术上的准确性。 + + +作何 Kubernetes 组织成员都可以在评论中增加 `/hold` 标签来阻止 PR 被合入。 +任何 Kubernetes 组织成员都可以移除 `/hold` 标签来让PR 合入(必须此前已有 `/lgtm` 和 `/approve` 标签)。 + + +#### 成为一个 member + + +在你成功的提交至少5个PR后,你就可以向Kubernetes 组织提交申请 [membership](https://github.com/kubernetes/community/blob/master/community-membership.md#member)。 +按照如下流程: + + +1. 找到两个 reviewer 或 approver 为你提名。 + + 通过[#sig-docs channel on the Kubernetes Slack instance](https://kubernetes.slack.com) 或者 + [SIG Docs mailing list](https://groups.google.com/forum/#!forum/kubernetes-sig-docs) + 来寻找为你提名的人。 + {{< note >}} + 不要单独发送邮件给某个人或在Slack中私聊。 + {{< /note >}} + +2. 在 `kubernetes/org` 仓库中提交一个 issue 发起请求。 + 按照[指导模板](https://github.com/kubernetes/community/blob/master/community-membership.md)填写请求。 + +3. 告知你的提名人,可以通过在 issue中 `@` 或者直接发送给他们issue链接, + 这样他们可以过来投票(`+1`)。 + +4. 当请求被批准后,github 管理员团队成员会告诉你批准加入并且关闭issue:"Congratulations, you are now a member!"。 + + +如果因为某些原因你的申请没有被批准,会员委员会成员会告诉你原因并指导你如何继续申请。 + +### Reviewers + + +Reviewers 是[@kubernetes/sig-docs-pr-reviews](https://github.com/orgs/kubernetes/teams/sig-docs-pr-reviews) 成员。 + + +Reviewers 负责检视文档的PR并提供反馈。 + + +每个PR都会自动分配 reviewer,任何贡献者都可以在评论中回复`/assign [@_github_handle]` +来请求某个reviewer来检视。 +如果reviewer觉得没有问题且不需要进一步更改时,reviewer 会在评论中回复 `/lgtm` 。 + + +如果自动分配的 reviewer 未能及时检视,其他的 reviewer 也会参与。 +此外,你可以指定某个 reviewer 或者等他们回复 `/lgtm`。 + + +对于不重要的更改或者非技术性的检视,SIG Docs 的 [approver](#approvers) 也可以提供 `/lgtm` 标签。 + + +如果一个reviewer在评论中回复 `/approve` 会被自动忽略。 + + +关于如何成为 SIG Docs reviewer 以及其责任、时间承诺等更多内容,请参照 +[Becoming a reviewer or approver](#becoming-an-approver-or-reviewer)。 + + +#### 成为 reviewer + + +当你满足[需求](https://github.com/kubernetes/community/blob/master/community-membership.md#reviewer)时, +你就可以成为 SIG Docs 的 reviewer。 +其他SIG的 reviewer 也需要单独向 SIG Docs 申请。 + + +通过提交一个PR并把自己加到位于 `kubernetes/website` 仓库顶层的 [top-level OWNERS file](https://github.com/kubernetes/website/blob/master/OWNERS) 文件中 +的 `reviewers` 部分,指定一个或多个当前 SIG Docs 的 approver。 + + +如果你的PR被批准,你就成为了 SIG Docs reviewer 了。 +[K8s-ci-robot](https://github.com/kubernetes/test-infra/tree/master/prow#bots-home) 会在接下来的 +PR 中请求你检视。 + + +如果构的PR被批准,你就会加入[@kubernetes/sig-docs-pr-reviews](https://github.com/orgs/kubernetes/teams/sig-docs-pr-reviews)组。 +只有`kubernetes-website-admins`组的成员才可以加入新成员。 + +### Approvers + + +approver 是GitHub [@kubernetes/sig-docs-maintainers](https://github.com/orgs/kubernetes/teams/sig-docs-maintainers) 组织成员。 +参考 [Teams and groups within SIG Docs](#teams-and-groups-within-sig-docs)。 + + +approver 有权限合入PR,这意味着他们可以发布内容到 Kubernetes 网站。 +如果一个 approver 留下 `/approve` 评论,则代表他批准了PR。 +如果非 approver 成员尝试批准,则会被自动忽略。 + + +如果某个PR已有 `/lgtm` 标签,approver 再回复一个 `/lgtm` ,则这个PR会自动合入。 +SIG Docs approver 应该只在不需要额外的技术检视的情况下才可以标记 `/lgtm`。 + + +关于如何成为 SIG Docs 的 approver 及其责任和时间承诺等信息,请参考[Becoming a reviewer or approver](#becoming-an-approver-or-reviewer)。 + + +#### 成为approver + + +当满足[要求](https://github.com/kubernetes/community/blob/master/community-membership.md#approver) +时,你可以成为 SIG Docs 的 approver。 +其他的SIG 的 approver 要想成为SIG Docs 的 approver 需要单独申请。 + + +通过提交一个PR并把自己加到位于 `kubernetes/website` 仓库顶层的 [top-level OWNERS file](https://github.com/kubernetes/website/blob/master/OWNERS) 文件中 +的 `approvers` 部分,指定一个或多个当前 SIG Docs 的 approver。 + + +一旦你的PR被批准,你就是一个 SIG Docs 的 approver 了。 + + +如果构的PR被批准,你就会加入[@kubernetes/sig-docs-maintainers](https://github.com/orgs/kubernetes/teams/sig-docs-maintainers)组。 +只有`kubernetes-website-admins`组的成员才可以加入新成员。 + +#### 成为网站管理员 + + +GitHub`kubernetes-website-admins`组织成员管理者各组的成员,并且拥有设置仓库的权限, +包括增加、删除和定位用的插件等。并不是所有的SIG Docs 的 approver 拥有此级别的权限。 + + +如果你觉得需要这个权限,可以与当前的网站管理员沟通,或者在[Kubernetes Slack](https://kubernetes.slack.com)中询问。 + + +#### PR 协调者 + + +每个 SIG Docs approver 都会被加入到 [PR Wrangler rotation scheduler](https://github.com/kubernetes/website/wiki/PR-Wranglers)。 +所有 SIG Docs approver 都会参与轮值。 +更多信息,请参考 [做一周的PR协调者](/docs/contribute/advanced#be-the-pr-wrangler-for-a-week)。 + + +#### SIG Docs 主席 + + +每个SIG,包括 SIG Docs,都会选出1位或多位成员作为主席。 +主席会成为 SIG Docs 和其他Kubernetes 组织的联络接口人。 +他们需要了解整个Kubernetes项目,并明白 SIG Docs如何运作。 +如需查询当前的主席,请查阅[Leadership](https://github.com/kubernetes/community/tree/master/sig-docs#leadership)。 + + +## SIG Docs 团队和自动化 + + +SIG文档中的自动化依赖于两种不同的自动化机制: +GitHub组和OWNERS文件。 + +### GitHub groups + + +SIG Docs 组定义了两个GitHub组: + + - [@kubernetes/sig-docs-maintainers](https://github.com/orgs/kubernetes/teams/sig-docs-maintainers) + - [@kubernetes/sig-docs-pr-reviews](https://github.com/orgs/kubernetes/teams/sig-docs-pr-reviews) + + +可以在GitHub的评论中`@name`他们来与他们沟通。 + + +这些团队与自动化工具使用的组有所重叠,但并不完全匹配。 +对于分配issue、拉请求和批准PR,自动化使用来自OWNERS文件的信息。 + + +### OWNERS 文件和扉页 + + +Kubernetes项目使用名为 prow 的自动化工具来处理 GitHub issue 和 PR。 +[Kubernetes website repository](https://github.com/kubernetes/website) 使用了两个 +[prow 插件](https://github.com/kubernetes/test-infra/blob/master/prow/plugins.yaml#L210): + +- blunderbuss +- approve + + +这两个插件使用位于 `kubernetes/website` 仓库顶层的 +[OWNERS](https://github.com/kubernetes/website/blob/master/OWNERS) 和 +[OWNERS_ALIASES](https://github.com/kubernetes/website/blob/master/OWNERS_ALIASES) +来控制工作流程。 + + +OWNERS 文件包含 SIG Docs reviewer 和 approver的列表。 +OWNERS 文件也可以存在于子目录中中,可以重写 reviewer 和 approver,并且它自动继乘上级。 +关于OWNERS的更多信息,请参考[OWNERS](https://github.com/kubernetes/community/blob/master/contributors/guide/owners.md)。 + + +此外,一个单独的 Markdown 格式的文件将会列出 reviewer 和 approver(扉页),或者列出 +其GitHub 用户名 或者列出其组名。 + + +结合 OWNERS 文件及扉页可以给PR作者提供向谁请求检视的建议。 + +{{% /capture %}} + +{{% capture whatsnext %}} + + +关于贡献Kubernetes 的更多文档,请参考: + +- [Start contributing](/docs/contribute/start/) +- [Documentation style](/docs/contribute/style/) + +{{% /capture %}} + +