From 34375defadba637c1b57b2aa243dc661552cbc76 Mon Sep 17 00:00:00 2001 From: Sean Wei Date: Sun, 19 Jun 2022 00:48:00 +0800 Subject: [PATCH] [zh] Fix links for contribute --- content/zh-cn/docs/contribute/_index.md | 42 ++++----- content/zh-cn/docs/contribute/advanced.md | 94 ++++++++++--------- .../docs/contribute/participate/_index.md | 28 +++--- .../participate/roles-and-responsibilities.md | 22 ++--- .../docs/contribute/review/reviewing-prs.md | 24 +++-- 5 files changed, 111 insertions(+), 99 deletions(-) diff --git a/content/zh-cn/docs/contribute/_index.md b/content/zh-cn/docs/contribute/_index.md index 9c07ae55b9..b21312ff8b 100644 --- a/content/zh-cn/docs/contribute/_index.md +++ b/content/zh-cn/docs/contribute/_index.md @@ -61,7 +61,7 @@ Kubernetes documentation contributors: - Translate the documentation - Manage and publish the documentation parts of the Kubernetes release cycle --> -本网站由 [Kubernetes SIG(特别兴趣小组)Docs](/zh/docs/contribute/#get-involved-with-SIG-Docs) 维护。 +本网站由 [Kubernetes SIG Docs](/zh-cn/docs/contribute/#get-involved-with-SIG-Docs)(文档特别兴趣小组)维护。 Kubernetes 文档项目的贡献者: @@ -103,7 +103,7 @@ To get involved with documentation: 1. 签署 CNCF 的[贡献者许可协议](https://github.com/kubernetes/community/blob/master/CLA.md)。 2. 熟悉[文档仓库](https://github.com/kubernetes/website)和网站的[静态站点生成器](https://gohugo.io)。 -3. 确保理解[发起 PR](/zh/docs/contribute/new-content/open-a-pr/) 和[审查变更](/zh/docs/contribute/review/reviewing-prs/)的基本流程。 +3. 确保理解[发起 PR](/zh-cn/docs/contribute/new-content/open-a-pr/) 和[审查变更](/zh-cn/docs/contribute/review/reviewing-prs/)的基本流程。 @@ -157,9 +157,9 @@ Figure 1 outlines a roadmap for new contributors. You can follow some or all of 图 1. 新手入门指示。 图 1 概述了新贡献者的路线图。 -你可以遵从`注册`和`评审`所述的某些或全部步骤。 +你可以遵从“注册”和“评审”所述的某些或全部步骤。 至此,你完成了发起 PR 的准备工作, -可以通过`发起 PR`列出的事项实现你的贡献目标。 +可以通过“发起 PR” 列出的事项实现你的贡献目标。 再次重申,欢迎随时提出问题! 有些任务要求 Kubernetes 组织内更高的信任级别和访问权限。 -阅读[参与 SIG Docs 工作](/zh/docs/contribute/participate/) ,获取角色和权限的更多细节。 +阅读[参与 SIG Docs 工作](/zh-cn/docs/contribute/participate/),获取角色和权限的更多细节。 -- 通读[贡献概述](/zh/docs/contribute/new-content/overview/),了解参与贡献的不同方式。 -- 查看 [`kubernetes/website` 问题列表](https://github.com/kubernetes/website/issues/) - ,检索最适合作为切入点的问题。 -- 在现有文档上,[使用 GitHub 提交 PR](/zh/docs/contribute/new-content/open-a-pr/#changes-using-github), +- 通读[贡献概述](/zh-cn/docs/contribute/new-content/),了解参与贡献的不同方式。 +- 查看 [`kubernetes/website` 问题列表](https://github.com/kubernetes/website/issues/), + 检索最适合作为切入点的问题。 +- 在现有文档上,[使用 GitHub 提交 PR](/zh-cn/docs/contribute/new-content/open-a-pr/#changes-using-github), 掌握在 GitHub 上登记 Issue 的方法。 -- Kubernetes 社区其他成员会[评审 PR ](/zh/docs/contribute/review/reviewing-prs/), +- Kubernetes 社区其他成员会[评审 PR ](/zh-cn/docs/contribute/review/reviewing-prs/), 以确保文档精准和语言流畅。 -- 阅读 kubernetes 的[内容指南](/zh/docs/contribute/style/content-guide/)和 - [风格指南](/zh/docs/contribute/style/style-guide/),以发表有见地的评论。 -- 了解[页面内容类型](/zh/docs/contribute/style/page-content-types/)和 - [Hugo 短代码](/zh/docs/contribute/style/hugo-shortcodes/)。 +- 阅读 kubernetes 的[内容指南](/zh-cn/docs/contribute/style/content-guide/)和 + [风格指南](/zh-cn/docs/contribute/style/style-guide/),以发表有见地的评论。 +- 了解[页面内容类型](/zh-cn/docs/contribute/style/page-content-types/)和 + [Hugo 短代码](/zh-cn/docs/contribute/style/hugo-shortcodes/)。 ## 下一步 {#next-teps} -- 学习在仓库的[本地克隆中工作](/zh/docs/contribute/new-content/open-a-pr/#fork-the-repo)。 -- 为[发行版的特性](/zh/docs/contribute/new-content/new-features/)编写文档。 -- 加入 [SIG Docs](/zh/docs/contribute/participate/),并成为[成员或评审者](/zh/docs/contribute/participate/roles-and-responsibilities/)。 +- 学习在仓库的[本地克隆中工作](/zh-cn/docs/contribute/new-content/open-a-pr/#fork-the-repo)。 +- 为[发行版的特性](/zh-cn/docs/contribute/new-content/new-features/)编写文档。 +- 加入 [SIG Docs](/zh-cn/docs/contribute/participate/),并成为[成员或评审者](/zh-cn/docs/contribute/participate/roles-and-responsibilities/)。 -- 开始或帮助[本地化](/zh/docs/contribute/localization/) 工作。 +- 开始或帮助[本地化](/zh-cn/docs/contribute/localization/) 工作。 ## 参与 SIG Docs 工作 {#get-involved-with-SIG-Docs} -[SIG Docs](/zh/docs/contribute/participate/) 是负责发布、维护 Kubernetes 文档的贡献者团体。 +[SIG Docs](/zh-cn/docs/contribute/participate/) 是负责发布、维护 Kubernetes 文档的贡献者团体。 参与 SIG Docs 是 Kubernetes 贡献者(开发者和其他人员)对 Kubernetes 项目产生重大影响力的好方式。 SIG Docs 的几种沟通方式: @@ -306,10 +306,10 @@ SIG Docs 的几种沟通方式: --> ## 其他贡献方式 {#other-ways-to-contribute} -- 访问 [Kubernetes 社区网站](/zh/community/)。 +- 访问 [Kubernetes 社区网站](/zh-cn/community/)。 参与 Twitter 或 Stack Overflow,了解当地的 Kubernetes 会议和活动等等。 - 阅读[贡献者备忘单](https://github.com/kubernetes/community/tree/master/contributors/guide/contributor-cheatsheet), 参与 Kubernetes 功能开发。 - 访问贡献者网站,进一步了解有关 [Kubernetes 贡献者](https://www.kubernetes.dev/) 和[更多贡献者资源](https://www.kubernetes.dev/resources/)的信息。 -- 提交一篇[博客文章或案例研究](/zh/docs/contribute/new-content/blogs-case-studies/)。 +- 提交一篇[博客文章或案例研究](/zh-cn/docs/contribute/new-content/blogs-case-studies/)。 diff --git a/content/zh-cn/docs/contribute/advanced.md b/content/zh-cn/docs/contribute/advanced.md index 3387a4c0be..b521a655a8 100644 --- a/content/zh-cn/docs/contribute/advanced.md +++ b/content/zh-cn/docs/contribute/advanced.md @@ -21,8 +21,8 @@ to learn about more ways to contribute. You need to use the Git command line client and other tools for some of these tasks. --> -如果你已经了解如何[贡献新内容](/zh/docs/contribute/new-content/overview/)和 -[评阅他人工作](/zh/docs/contribute/review/reviewing-prs/),并准备了解更多贡献的途径, +如果你已经了解如何[贡献新内容](/zh-cn/docs/contribute/new-content/)和 +[评阅他人工作](/zh-cn/docs/contribute/review/reviewing-prs/),并准备了解更多贡献的途径, 请阅读此文。你需要使用 Git 命令行工具和其他工具做这些工作。 @@ -30,11 +30,12 @@ client and other tools for some of these tasks. -## 提出改进建议 +## 提出改进建议 {#propose-improvements} -SIG Docs 的 [成员](/zh/docs/contribute/participate/roles-and-responsibilities/#members) 可以提出改进建议。 +SIG Docs 的[成员](/zh-cn/docs/contribute/participate/roles-and-responsibilities/#members) 可以提出改进建议。 -在对 Kubernetes 文档贡献了一段时间后,你可能会对[样式指南](/zh/docs/contribute/style/style-guide/)、 -[内容指南](/zh/docs/contribute/style/content-guide/)、用于构建文档的工具链、网站样式、 +在对 Kubernetes 文档贡献了一段时间后,你可能会对[样式指南](/zh-cn/docs/contribute/style/style-guide/)、 +[内容指南](/zh-cn/docs/contribute/style/content-guide/)、用于构建文档的工具链、网站样式、 评审和合并 PR 的流程或者文档的其他方面产生改进的想法。 为了尽可能透明化,这些提议都需要在 SIG Docs 会议或 [kubernetes-sig-docs 邮件列表](https://groups.google.com/forum/#!forum/kubernetes-sig-docs)上讨论。 @@ -66,18 +67,19 @@ appropriate. For instance, an update to the style guide or the website's functionality might involve opening a pull request, while a change related to documentation testing might involve working with sig-testing. --> -在进行了讨论并且 SIG 就期望的结果达成一致之后,你就能以最合理的方式处理改进建议了。例如,样式指南或网站功能的更新可能涉及 PR 的新增,而与文档测试相关的更改可能涉及 sig-testing。 +在进行了讨论并且 SIG 就期望的结果达成一致之后,你就能以最合理的方式处理改进建议了。 +例如,样式指南或网站功能的更新可能涉及 PR 的新增,而与文档测试相关的更改可能涉及 sig-testing。 -## 为 Kubernetes 版本发布协调文档工作 +## 为 Kubernetes 版本发布协调文档工作 {#coordinate-docs-for-a-kubernetes-release} -SIG Docs 的[批准者(approvers)](/zh/docs/contribute/participating/#approvers) 可以为 -Kubernetes 版本发布协调文档工作。 +SIG Docs 的[批准者(approvers)](/zh-cn/docs/contribute/participate/roles-and-responsibilities/#approvers) +可以为 Kubernetes 版本发布协调文档工作。 -## 担任新的贡献者大使 +## 担任新的贡献者大使 {#serve-as-a-new-contributor-ambassador} -SIG Docs [批准人(Approvers)](/zh/docs/contribute/participating/#approvers) +SIG Docs [批准人(Approvers)](/zh-cn/docs/contribute/participate/roles-and-responsibilities/#approvers) 可以担任新的贡献者大使。 -新的贡献者大使共同努力欢迎 SIG-Docs 的新贡献者,对新贡献者的 PR 提出建议, +新的贡献者大使欢迎 SIG-Docs 的新贡献者,对新贡献者的 PR 提出建议, 以及在前几份 PR 提交中指导新贡献者。 新的贡献者大使的职责包括: - 监听 [Kubernetes #sig-docs 频道](https://kubernetes.slack.com) 上新贡献者的 Issue。 -- 与 PR 管理者合作为新参与者寻找[合适的第一个 issues](https://kubernetes.dev/docs/guide/help-wanted/#good-first-issue) 。 -- 通过前几个 PR 指导新贡献者为文档存储库作贡献。 +- 与 PR 管理者合作为新参与者寻找[合适的第一个 issues](https://kubernetes.dev/docs/guide/help-wanted/#good-first-issue)。 +- 通过前几个 PR 指导新贡献者为文档存储库作贡献。 - 帮助新的贡献者创建成为 Kubernetes 成员所需的更复杂的 PR。 - [为贡献者提供保荐](#sponsor-a-new-contributor),使其成为 Kubernetes 成员。 - 每月召开一次会议,帮助和指导新的贡献者。 @@ -172,22 +174,23 @@ Current New Contributor Ambassadors are announced at each SIG-Docs meeting and i ## 为新的贡献者提供保荐 {#sponsor-a-new-contributor} -SIG Docs 的[评审人(Reviewers)](/zh/docs/contribute/participating/#reviewers) 可以为新的贡献者提供保荐。 +SIG Docs 的[评审人(Reviewers)](/zh-cn/docs/contribute/participate/roles-and-responsibilities/#reviewers) +可以为新的贡献者提供保荐。 新的贡献者针对一个或多个 Kubernetes 项目仓库成功提交了 5 个实质性 PR 之后, -就有资格申请 Kubernetes 组织的[成员身份](/zh/docs/contribute/participate/roles-and-responsibilities/#members)。 +就有资格申请 Kubernetes 组织的[成员身份](/zh-cn/docs/contribute/participate/roles-and-responsibilities/#members)。 贡献者的成员资格需要同时得到两位评审人的保荐。 -## 担任 SIG 联合主席 +## 担任 SIG 联合主席 {#sponsor-a-new-contributor} -SIG Docs [成员(Members)](/zh/docs/contribute/participate/roles-and-responsibilities/#members) +SIG Docs [成员(Members)](/zh-cn/docs/contribute/participate/roles-and-responsibilities/#members) 可以担任 SIG Docs 的联合主席。 -### 前提条件 +### 前提条件 {#prerequisites} -### 职责范围 +### 职责范围 {#responsibilities} 联合主席主要提供以下服务: 联合主席负责处理流程和政策、时间安排和召开会议、安排 PR 管理员、以及一些其他人不想做的事情,目的是增长贡献者团队。 @@ -282,7 +290,7 @@ To schedule and run effective meetings, these guidelines show what to do, how to - Hold respectful, inclusive discussions with respectful, inclusive language. --> -### 召开高效的会议 +### 召开高效的会议 {#running-effective-meetings} 为了安排和召开高效的会议,这些指南说明了如何做、怎样做以及原因。 @@ -332,7 +340,7 @@ For weekly meetings, copypaste the previous week's notes into the "Past meetings **Honor folks' time**: -- Begin and end meetings punctually +Begin and end meetings on time. --> **根据需要来进行协调**: @@ -341,7 +349,7 @@ For weekly meetings, copypaste the previous week's notes into the "Past meetings **尊重大家的时间**: -- 准时开始和结束会议 +按时开始和结束会议 -### 录制 Zoom 会议 +### 录制 Zoom 会议 {#recording-meetings-on-zoom} 准备开始录制时,请单击“录制到云”。 diff --git a/content/zh-cn/docs/contribute/participate/_index.md b/content/zh-cn/docs/contribute/participate/_index.md index ba6ab0c738..42b4df0ef6 100644 --- a/content/zh-cn/docs/contribute/participate/_index.md +++ b/content/zh-cn/docs/contribute/participate/_index.md @@ -40,8 +40,8 @@ SIG Docs 欢迎所有贡献者提供内容和审阅。任何人可以提交拉 欢迎所有人对文档内容创建 Issue 和对正在处理中的 PR 进行评论。 -你也可以成为[成员(member)](/docs/contribute/participating/roles-and-responsibilities/#members)、 -[评阅人(reviewer)](/docs/contribute/participating/roles-and-responsibilities/#reviewers) 或者 -[批准人(approver)](/docs/contribute/participating/roles-and-responsibilities/#approvers)。 +你也可以成为[成员(member)](/zh-cn/docs/contribute/participate/roles-and-responsibilities/#members)、 +[评阅人(reviewer)](/zh-cn/docs/contribute/participate/roles-and-responsibilities/#reviewers) 或者 +[批准人(approver)](/zh-cn/docs/contribute/participate/roles-and-responsibilities/#approvers)。 这些角色拥有更高的权限,且需要承担批准和提交变更的责任。 有关 Kubernetes 社区中的成员如何工作的更多信息,请参见 [社区成员身份](https://github.com/kubernetes/community/blob/master/community-membership.md)。 @@ -72,7 +72,7 @@ of the Kubernetes project as a whole and how SIG Docs works within it. See [Leadership](https://github.com/kubernetes/community/tree/master/sig-docs#leadership) for the current list of chairpersons. --> -## SIG Docs 主席 +## SIG Docs 主席 {#sig-docs-chairperson} 每个 SIG,包括 SIG Docs,都会选出一位或多位成员作为主席。 主席会成为 SIG Docs 和其他 Kubernetes 组织的联络接口人。 @@ -125,7 +125,7 @@ related to GitHub issues and pull requests. The [Kubernetes website repository](https://github.com/kubernetes/website) uses two [prow plugins](https://github.com/kubernetes/test-infra/blob/master/prow/plugins): --> -### OWNERS 文件和扉页 +### OWNERS 文件和扉页 {#owners-files-and-front-matter} Kubernetes 项目使用名为 prow 的自动化工具来自动处理 GitHub issue 和 PR。 [Kubernetes website 仓库](https://github.com/kubernetes/website) 使用了两个 @@ -144,7 +144,7 @@ how prow works within the repository. 这两个插件使用位于 `kubernetes/website` 仓库顶层的 [OWNERS](https://github.com/kubernetes/website/blob/main/OWNERS) 文件和 [OWNERS_ALIASES](https://github.com/kubernetes/website/blob/main/OWNERS_ALIASES) -文件来控制 prow 在仓库范围的工作方式。 +文件来控制 prow 在仓库范围的工作方式。 -OWNERS 文件包含 SIG Docs 评阅人和批准人的列表。 +OWNERS 文件包含 SIG Docs 评阅人和批准人的列表。 OWNERS 文件也可以存在于子目录中,可以在子目录层级重新设置哪些人可以作为评阅人和 -批准人,并将这一设定传递到下层子目录。 +批准人,并将这一设定传递到下层子目录。 关于 OWNERS 的更多信息,请参考 [OWNERS](https://github.com/kubernetes/community/blob/master/contributors/guide/owners.md) 文档。 @@ -206,7 +206,7 @@ SIG Docs 批准人。下面是合并的工作机制: - 所有 Kubernetes 成员可以通过 `/lgtm` 评论添加 `lgtm` 标签。 - 只有 SIG Docs 批准人可以通过评论 `/approve` 合并 PR。 某些批准人还会执行一些其他角色,例如 - [PR 管理者](/zh/docs/contribute/participate/pr-wranglers/) 或 + [PR 管理者](/zh-cn/docs/contribute/participate/pr-wranglers/) 或 [SIG Docs 主席](#sig-docs-chairperson)等。 ## {{% heading "whatsnext" %}} @@ -220,6 +220,6 @@ For more information about contributing to the Kubernetes documentation, see: --> 关于贡献 Kubernetes 文档的更多信息,请参考: -- [贡献新内容](/zh/docs/contribute/new-content/overview/) -- [评阅内容](/zh/docs/contribute/review/reviewing-prs) -- [文档样式指南](/zh/docs/contribute/style/) +- [贡献新内容](/zh-cn/docs/contribute/new-content/) +- [评阅内容](/zh-cn/docs/contribute/review/reviewing-prs) +- [文档样式指南](/zh-cn/docs/contribute/style/) diff --git a/content/zh-cn/docs/contribute/participate/roles-and-responsibilities.md b/content/zh-cn/docs/contribute/participate/roles-and-responsibilities.md index 1f77ba8bbc..fc410d5845 100644 --- a/content/zh-cn/docs/contribute/participate/roles-and-responsibilities.md +++ b/content/zh-cn/docs/contribute/participate/roles-and-responsibilities.md @@ -62,12 +62,12 @@ For more information, see [contributing new content](/docs/contribute/new-conten [SIG Docs 邮件列表](https://groups.google.com/forum/#!forum/kubernetes-sig-docs) 上提出改进建议。 -在[签署了 CLA](/zh/docs/contribute/new-content/overview/#sign-the-cla) 之后,任何人还可以: +在[签署了 CLA](/zh-cn/docs/contribute/new-content/#sign-the-cla) 之后,任何人还可以: - 发起拉取请求(PR),改进现有内容、添加新内容、撰写博客或者案例分析 - 创建示意图、图形资产或者嵌入式的截屏和视频内容 -进一步的详细信息,可参见[贡献新内容](/zh/docs/contribute/new-content/)。 +进一步的详细信息,可参见[贡献新内容](/zh-cn/docs/contribute/new-content/)。 1. 找到两个[评审人](#reviewers)或[批准人](#approvers)为你的成员身份提供 - [担保](/zh/docs/contribute/advanced#sponsor-a-new-contributor)。 + [担保](/zh-cn/docs/contribute/advanced#sponsor-a-new-contributor)。 通过 [Kubernetes Slack 上的 #sig-docs 频道](https://kubernetes.slack.com) 或者 [SIG Docs 邮件列表](https://groups.google.com/forum/#!forum/kubernetes-sig-docs) @@ -242,7 +242,7 @@ A `/lgtm` comment from reviewer is binding and triggers automation that adds the 如果所指派的评审人未能及时评审,其他的评审人也可以参与进来。 你可以根据需要指派技术评审人。 -### 使用 `/lgtm` +### 使用 `/lgtm` {#using-lgtm} LGTM 代表的是 “Looks Good To Me (我觉得可以)”,用来标示某个 PR 在技术上是准确的,可以被合并。 @@ -293,7 +293,7 @@ If approved, a SIG Docs lead adds you to the appropriate GitHub team. Once added 下列举的用户名)。 申请被批准之后,SIG Docs Leads 之一会将你添加到合适的 GitHub 团队。 -一旦添加完成, [@k8s-ci-robot](https://github.com/kubernetes/test-infra/tree/master/prow#bots-home) +一旦添加完成,[@k8s-ci-robot](https://github.com/kubernetes/test-infra/tree/master/prow#bots-home) 会在处理未来的 PR 时,将 PR 指派给你或者建议你来评审某 PR。 -- 阅读 [PR 管理者](/zh/docs/contribute/participate/pr-wranglers/),了解所有批准人轮值的角色。 +- 阅读 [PR 管理者](/zh-cn/docs/contribute/participate/pr-wranglers/),了解所有批准人轮值的角色。 diff --git a/content/zh-cn/docs/contribute/review/reviewing-prs.md b/content/zh-cn/docs/contribute/review/reviewing-prs.md index d8eb48f1d6..4fdbde162b 100644 --- a/content/zh-cn/docs/contribute/review/reviewing-prs.md +++ b/content/zh-cn/docs/contribute/review/reviewing-prs.md @@ -12,6 +12,7 @@ weight: 10 --> + 任何人均可评审文档的拉取请求。 访问 Kubernetes 网站仓库的 [pull requests](https://github.com/kubernetes/website/pulls) 部分, @@ -34,11 +37,12 @@ Before reviewing, it's a good idea to: 在评审之前,可以考虑: -- 阅读[内容指南](/zh/docs/contribute/style/content-guide/)和 - [样式指南](/zh/docs/contribute/style/style-guide/)以便给出有价值的评论。 -- 了解 Kubernetes 文档社区中不同的[角色和职责](/zh/docs/contribute/participate/roles-and-responsibilities/)。 +- 阅读[内容指南](/zh-cn/docs/contribute/style/content-guide/)和 + [样式指南](/zh-cn/docs/contribute/style/style-guide/)以便给出有价值的评论。 +- 了解 Kubernetes 文档社区中不同的[角色和职责](/zh-cn/docs/contribute/participate/roles-and-responsibilities/)。 +