Skip to content

Commit b6af695

Browse files
authored
Merge pull request #29475 from howieyuen/contribution-part-1
[zh]sync contribution files for 1.22(Part-1)
2 parents 433480d + 55c7993 commit b6af695

File tree

6 files changed

+39
-38
lines changed

6 files changed

+39
-38
lines changed

content/zh/docs/contribute/new-content/blogs-case-studies.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -101,15 +101,15 @@ Kubernetes 博客用于项目发布新功能特性、社区报告以及其他一
101101
<!--
102102
- Blog posts should be original content
103103
- The official blog is not for repurposing existing content from a third party as new content.
104-
- The [license](https://github.com/kubernetes/website/blob/master/LICENSE) for the blog allows commercial use of the content for commercial purposes, just not the other way around.
104+
- The [license](https://github.com/kubernetes/website/blob/main/LICENSE) for the blog allows commercial use of the content for commercial purposes, just not the other way around.
105105
- Blog posts should aim to be future proof
106106
- Given the development velocity of the project, we want evergreen content that won't require updates to stay accurate for the reader.
107107
- It can be a better choice to add a tutorial or update official documentation than to write a high level overview as a blog post.
108108
- Consider concentrating the long technical content as a call to action of the blog post, and focus on the problem space or why readers should care.
109109
-->
110110
- 博客文章应该是原创内容。
111111
- 官方博客的目的不是将某第三方已发表的内容重新作为新内容发表。
112-
- 博客的[授权协议](https://github.com/kubernetes/website/blob/master/LICENSE)
112+
- 博客的[授权协议](https://github.com/kubernetes/website/blob/main/LICENSE)
113113
的确允许出于商业目的来使用博客内容;但并不是所有可以商用的内容都适合在这里发表。
114114
- 博客文章的内容应该在一段时间内不过期。
115115
- 考虑到项目的开发速度,我们希望读者看到的是不必更新就能保持长期准确的内容。
@@ -144,7 +144,7 @@ SIG Docs [博客子项目](https://github.com/kubernetes/community/tree/master/s
144144

145145
要提交博文,你可以遵从以下指南:
146146
<!--
147-
- [Open a pull request](/docs/contribute/new-content/open-a-pr/#fork-the-repo) with a new blog post. New blog posts go under the [`content/en/blog/_posts`](https://github.com/kubernetes/website/tree/master/content/en/blog/_posts) directory.
147+
- [Open a pull request](/docs/contribute/new-content/open-a-pr/#fork-the-repo) with a new blog post. New blog posts go under the [`content/en/blog/_posts`](https://github.com/kubernetes/website/tree/main/content/en/blog/_posts) directory.
148148
149149
- Ensure that your blog post follows the correct naming conventions and the following frontmatter (metadata) information:
150150
@@ -153,7 +153,7 @@ SIG Docs [博客子项目](https://github.com/kubernetes/community/tree/master/s
153153
- The front matter must include the following:
154154
-->
155155
- [发起一个包含博文的 PR](/zh/docs/contribute/new-content/open-a-pr/#fork-the-repo)
156-
新博文要创建于 [`content/en/blog/_posts`](https://github.com/kubernetes/website/tree/master/content/en/blog/_posts) 目录下。
156+
新博文要创建于 [`content/en/blog/_posts`](https://github.com/kubernetes/website/tree/main/content/en/blog/_posts) 目录下。
157157

158158
- 确保你的博文遵从合适的命名规范,并带有下面的引言(元数据)信息:
159159

@@ -205,7 +205,7 @@ Case studies highlight how organizations are using Kubernetes to solve
205205
real-world problems. The Kubernetes marketing team and members of the {{< glossary_tooltip text="CNCF" term_id="cncf" >}} collaborate with you on all case studies.
206206

207207
Have a look at the source for the
208-
[existing case studies](https://github.com/kubernetes/website/tree/master/content/en/case-studies).
208+
[existing case studies](https://github.com/kubernetes/website/tree/main/content/en/case-studies).
209209

210210
Refer to the [case study guidelines](https://github.com/cncf/foundation/blob/master/case-study-guidelines.md) and submit your request as outlined in the guidelines.
211211
-->
@@ -216,7 +216,7 @@ Kubernetes 市场化团队和 {{< glossary_tooltip text="CNCF" term_id="cncf" >}
216216
会与你一起工作,撰写所有的案例分析。
217217

218218
请查看
219-
[现有案例分析](https://github.com/kubernetes/website/tree/master/content/en/case-studies)
219+
[现有案例分析](https://github.com/kubernetes/website/tree/main/content/en/case-studies)
220220
的源码。
221221

222222
参考[案例分析指南](https://github.com/cncf/foundation/blob/master/case-study-guidelines.md)

content/zh/docs/contribute/new-content/open-a-pr.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -222,9 +222,9 @@ Make sure you have [git](https://git-scm.com/book/en/v2/Getting-Started-Installi
222222
upstream https://github.com/kubernetes/website.git (push)
223223
```
224224
<!--
225-
6. Fetch commits from your fork's `origin/master` and `kubernetes/website`'s `upstream/master`:
225+
6. Fetch commits from your fork's `origin/master` and `kubernetes/website`'s `upstream/main`:
226226
-->
227-
6. 从你的克隆副本取回 `origin/master` 分支,从 `kubernetes/website` 取回 `upstream/master`
227+
6. 从你的克隆副本取回 `origin/master` 分支,从 `kubernetes/website` 取回 `upstream/main`
228228

229229
```bash
230230
git fetch origin
@@ -236,19 +236,20 @@ Make sure you have [git](https://git-scm.com/book/en/v2/Getting-Started-Installi
236236
这样可以确保你本地的仓库在开始工作前是最新的。
237237

238238
<!--
239-
This workflow is different than the [Kubernetes Community GitHub Workflow](https://github.com/kubernetes/community/blob/master/contributors/guide/github-workflow.md). You do not need to merge your local copy of `master` with `upstream/master` before pushing updates to your fork.
239+
This workflow is different than the [Kubernetes Community GitHub Workflow](https://github.com/kubernetes/community/blob/master/contributors/guide/github-workflow.md). You do not need to merge your local copy of `main` with `upstream/main` before pushing updates to your fork.
240240
-->
241241
{{< note >}}
242-
此工作流程与 [Kubernetes 社区 GitHub 工作流](https://github.com/kubernetes/community/blob/master/contributors/guide/github-workflow.md)有所不同。在推送你的变更到你的远程派生副本库之前,你不需要将你本地的 `master``upstream/master` 合并。
242+
此工作流程与 [Kubernetes 社区 GitHub 工作流](https://github.com/kubernetes/community/blob/master/contributors/guide/github-workflow.md)有所不同。
243+
在推送你的变更到你的远程派生副本库之前,你不需要将你本地的 `main``upstream/main` 合并。
243244
{{< /note >}}
244245

245246
<!--
246247
### Create a branch
247248

248249
1. Decide which branch base to your work on:
249250

250-
- For improvements to existing content, use `upstream/master`.
251-
- For new content about existing features, use `upstream/master`.
251+
- For improvements to existing content, use `upstream/main`.
252+
- For new content about existing features, use `upstream/main`.
252253
- For localized content, use the localization's conventions. For more information, see [localizing Kubernetes documentation](/docs/contribute/localization/).
253254
- For new features in an upcoming Kubernetes release, use the feature branch. For more information, see [documenting for a release](/docs/contribute/new-content/new-features/).
254255
- For long-running efforts that multiple SIG Docs contributors collaborate on,
@@ -261,8 +262,8 @@ Make sure you have [git](https://git-scm.com/book/en/v2/Getting-Started-Installi
261262
262263
1. 决定你要基于哪个分支来开展工作:
263264
264-
- 针对已有内容的改进,请使用 `upstream/master`;
265-
- 针对已有功能特性的新文档内容,请使用 `upstream/master`;
265+
- 针对已有内容的改进,请使用 `upstream/main`;
266+
- 针对已有功能特性的新文档内容,请使用 `upstream/main`;
266267
- 对于本地化内容,请基于本地化的约定。
267268
可参考[对 Kubernetes 文档进行本地化](/zh/docs/contribute/localization/)了解详细信息。
268269
- 对于在下一个 Kubernetes 版本中新功能特性的文档,使用独立的功能特性分支。
@@ -273,13 +274,13 @@ Make sure you have [git](https://git-scm.com/book/en/v2/Getting-Started-Installi
273274
如果你在选择分支上需要帮助,请在 `#sig-docs` Slack 频道提问。
274275
275276
<!--
276-
2. Create a new branch based on the branch identified in step 1. This example assumes the base branch is `upstream/master`:
277+
2. Create a new branch based on the branch identified in step 1. This example assumes the base branch is `upstream/main`:
277278
-->
278279
2. 基于第一步中选定的分支,创建新分支。
279-
下面的例子假定基础分支是 `upstream/master`:
280+
下面的例子假定基础分支是 `upstream/main`:
280281
281282
```bash
282-
git checkout -b <my_new_branch> upstream/master
283+
git checkout -b <my_new_branch> upstream/main
283284
```
284285
<!--
285286
3. Make your changes using a text editor.
@@ -471,10 +472,10 @@ Alternately, install and use the `hugo` command on your computer:
471472
另一种方式是,在你的本地计算机上安装并使用 `hugo` 命令:
472473

473474
<!--
474-
1. Install the [Hugo](https://gohugo.io/getting-started/installing/) version specified in [`website/netlify.toml`](https://raw.githubusercontent.com/kubernetes/website/master/netlify.toml).
475+
1. Install the [Hugo](https://gohugo.io/getting-started/installing/) version specified in [`website/netlify.toml`](https://raw.githubusercontent.com/kubernetes/website/main/netlify.toml).
475476
2. In a terminal, go to your Kubernetes website repository and start the Hugo server:
476477
-->
477-
1. 安装 [`website/netlify.toml`](https://raw.githubusercontent.com/kubernetes/website/master/netlify.toml)
478+
1. 安装 [`website/netlify.toml`](https://raw.githubusercontent.com/kubernetes/website/main/netlify.toml)
478479
文件中指定的 [Hugo](https://gohugo.io/getting-started/installing/) 版本。
479480

480481
2. 启动一个终端窗口,进入 Kubernetes 网站仓库目录,启动 Hugo 服务器:
@@ -651,13 +652,13 @@ If another contributor commits changes to the same file in another PR, it can cr
651652
git push --force-with-lease origin <your-branch-name>
652653
```
653654
<!--
654-
2. Fetch changes from `kubernetes/website`'s `upstream/master` and rebase your branch:
655+
2. Fetch changes from `kubernetes/website`'s `upstream/main` and rebase your branch:
655656
-->
656-
2. 从 `kubernetes/website` 的 `upstream/master` 分支取回更改,然后重设本地分支的基线:
657+
2. 从 `kubernetes/website` 的 `upstream/main` 分支取回更改,然后重设本地分支的基线:
657658
658659
```bash
659660
git fetch upstream
660-
git rebase upstream/master
661+
git rebase upstream/main
661662
```
662663
<!--
663664
3. Inspect the results of the rebase:

content/zh/docs/contribute/new-content/overview.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ When opening a pull request, you need to know in advance which branch to base yo
7474
7575
Scenario | Branch
7676
:---------|:------------
77-
Existing or new English language content for the current release | `master`
77+
Existing or new English language content for the current release | `main`
7878
Content for a feature change release | The branch which corresponds to the major and minor version the feature change is in, using the pattern `dev-release-<version>`. For example, if a feature changes in the `{{< latest-version >}}` release, then add documentation changes to the ``dev-{{< release-branch >}}`` branch.
7979
Content in other languages (localizations) | Use the localization's convention. See the [Localization branching strategy](/docs/contribute/localization/#branching-strategy) for more information.
8080
@@ -86,7 +86,7 @@ If you're still not sure which branch to choose, ask in `#sig-docs` on Slack.
8686

8787
场景 | 分支
8888
:---------|:------------
89-
针对当前发行版本的,对现有英文内容的修改或新的英文内容 | `master`
89+
针对当前发行版本的,对现有英文内容的修改或新的英文内容 | `main`
9090
针对功能特性变更的内容 | 功能特性所对应的版本所对应的分支,分支名字模式为 `dev-<version>`。例如,如果某功能特性在 `v{{< skew nextMinorVersion >}}` 版本发生变化,则对应的文档变化要添加到 ``dev-{{< skew nextMinorVersion >}}`` 分支。
9191
其他语言的内容(本地化)| 基于本地化团队的约定。参见[本地化分支策略](/zh/docs/contribute/localization/#branching-strategy)了解更多信息。
9292

@@ -111,12 +111,12 @@ Limit pull requests to one language per PR. If you need to make an identical cha
111111

112112
<!--
113113
## Tools for contributors
114-
The [doc contributors tools](https://github.com/kubernetes/website/tree/master/content/en/docs/doc-contributor-tools) directory in the `kubernetes/website` repository contains tools to help your contribution journey go more smoothly.
114+
The [doc contributors tools](https://github.com/kubernetes/website/tree/main/content/en/docs/doc-contributor-tools) directory in the `kubernetes/website` repository contains tools to help your contribution journey go more smoothly.
115115
-->
116116

117117
## 为贡献者提供的工具
118118

119119
`kubernetes/website` 仓库的
120-
[文档贡献者工具](https://github.com/kubernetes/website/tree/master/content/en/docs/doc-contributor-tools)
120+
[文档贡献者工具](https://github.com/kubernetes/website/tree/main/content/en/docs/doc-contributor-tools)
121121
目录中包含了一些工具,能够助你的贡献过程更为顺畅。
122122

content/zh/docs/contribute/participate/_index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -136,14 +136,14 @@ Kubernetes 项目使用名为 prow 的自动化工具来自动处理 GitHub issu
136136

137137
<!--
138138
These two plugins use the
139-
[OWNERS](https://github.com/kubernetes/website/blob/master/OWNERS) and
140-
[OWNERS_ALIASES](https://github.com/kubernetes/website/blob/master/OWNERS_ALIASES)
139+
[OWNERS](https://github.com/kubernetes/website/blob/main/OWNERS) and
140+
[OWNERS_ALIASES](https://github.com/kubernetes/website/blob/main/OWNERS_ALIASES)
141141
files in the top level of the `kubernetes/website` GitHub repository to control
142142
how prow works within the repository.
143143
-->
144144
这两个插件使用位于 `kubernetes/website` 仓库顶层的
145-
[OWNERS](https://github.com/kubernetes/website/blob/master/OWNERS) 文件和
146-
[OWNERS_ALIASES](https://github.com/kubernetes/website/blob/master/OWNERS_ALIASES)
145+
[OWNERS](https://github.com/kubernetes/website/blob/main/OWNERS) 文件和
146+
[OWNERS_ALIASES](https://github.com/kubernetes/website/blob/main/OWNERS_ALIASES)
147147
文件来控制 prow 在仓库范围的工作方式。
148148

149149
<!--

content/zh/docs/contribute/participate/pr-wranglers.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,8 @@ These queries exclude localization PRs. All queries are against the main branch
8989
Lists PRs that need an LGTM from a member. If the PR needs technical review, loop in one of the reviewers suggested by the bot. If the content needs work, add suggestions and feedback in-line.
9090
- [Has LGTM, needs docs approval](https://github.com/kubernetes/website/pulls?q=is%3Aopen+is%3Apr+-label%3Ado-not-merge%2Fwork-in-progress+-label%3Ado-not-merge%2Fhold+label%3Alanguage%2Fen+label%3Algtm+):
9191
Lists PRs that need an `/approve` comment to merge.
92-
- [Quick Wins](https://github.com/kubernetes/website/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aopen+base%3Amaster+-label%3A%22do-not-merge%2Fwork-in-progress%22+-label%3A%22do-not-merge%2Fhold%22+label%3A%22cncf-cla%3A+yes%22+label%3A%22size%2FXS%22+label%3A%22language%2Fen%22): Lists PRs against the main branch with no clear blockers. (change "XS" in the size label as you work through the PRs [XS, S, M, L, XL, XXL]).
93-
- [Not against the main branch](https://github.com/kubernetes/website/pulls?q=is%3Aopen+is%3Apr+label%3Alanguage%2Fen+-base%3Amaster): If the PR is against a `dev-` branch, it's for an upcoming release. Assign the [docs release manager](https://github.com/kubernetes/sig-release/tree/master/release-team#kubernetes-release-team-roles) using: `/assign @<manager's_github-username>`. If the PR is against an old branch, help the author figure out whether it's targeted against the best branch.
92+
- [Quick Wins](https://github.com/kubernetes/website/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aopen+base%3Amain+-label%3A%22do-not-merge%2Fwork-in-progress%22+-label%3A%22do-not-merge%2Fhold%22+label%3A%22cncf-cla%3A+yes%22+label%3A%22size%2FXS%22+label%3A%22language%2Fen%22): Lists PRs against the main branch with no clear blockers. (change "XS" in the size label as you work through the PRs [XS, S, M, L, XL, XXL]).
93+
- [Not against the primary branch](https://github.com/kubernetes/website/pulls?q=is%3Aopen+is%3Apr+label%3Alanguage%2Fen+-base%3Amain): If the PR is against a `dev-` branch, it's for an upcoming release. Assign the [docs release manager](https://github.com/kubernetes/sig-release/tree/master/release-team#kubernetes-release-team-roles) using: `/assign @<manager's_github-username>`. If the PR is against an old branch, help the author figure out whether it's targeted against the best branch.
9494
-->
9595
- [未签署 CLA,不可合并的 PR](https://github.com/kubernetes/website/pulls?q=is%3Aopen+is%3Apr+label%3A%22cncf-cla%3A+no%22+-label%3A%22do-not-merge%2Fwork-in-progress%22+-label%3A%22do-not-merge%2Fhold%22+label%3Alanguage%2Fen)
9696
提醒贡献者签署 CLA。如果机器人和审阅者都已经提醒他们,请关闭 PR,并提醒他们在签署 CLA 后可以重新提交。
@@ -105,11 +105,11 @@ These queries exclude localization PRs. All queries are against the main branch
105105
- [已有 LGTM标签,需要 Docs 团队批准](https://github.com/kubernetes/website/pulls?q=is%3Aopen+is%3Apr+-label%3Ado-not-merge%2Fwork-in-progress+-label%3Ado-not-merge%2Fhold+label%3Alanguage%2Fen+label%3Algtm+)
106106
列举需要 `/approve` 评论来合并的 PR。
107107

108-
- [快速批阅](https://github.com/kubernetes/website/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aopen+base%3Amaster+-label%3A%22do-not-merge%2Fwork-in-progress%22+-label%3A%22do-not-merge%2Fhold%22+label%3A%22cncf-cla%3A+yes%22+label%3A%22size%2FXS%22+label%3A%22language%2Fen%22)
108+
- [快速批阅](https://github.com/kubernetes/website/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aopen+base%3Amain+-label%3A%22do-not-merge%2Fwork-in-progress%22+-label%3A%22do-not-merge%2Fhold%22+label%3A%22cncf-cla%3A+yes%22+label%3A%22size%2FXS%22+label%3A%22language%2Fen%22)
109109
列举针对主分支的、没有明确合并障碍的 PR。
110110
在浏览 PR 时,可以将 "XS" 尺寸标签更改为 "S"、"M"、"L"、"XL"、"XXL"。
111111

112-
- [非主分支的 PR](https://github.com/kubernetes/website/pulls?q=is%3Aopen+is%3Apr+label%3Alanguage%2Fen+-base%3Amaster): If the PR is against a `dev-` branch, it's for an upcoming release. Assign the [docs release manager](https://github.com/kubernetes/sig-release/tree/master/release-team#kubernetes-release-team-roles) using: `/assign @<manager's_github-username>`. If the PR is against an old branch, help the author figure out whether it's targeted against the best branch.
112+
- [非主分支的 PR](https://github.com/kubernetes/website/pulls?q=is%3Aopen+is%3Apr+label%3Alanguage%2Fen+-base%3Amain):
113113
如果 PR 针对 `dev-` 分支,则表示它适用于即将发布的版本。
114114
请添加带有 `/assign @<负责人的 github 账号>`,将其指派给
115115
[发行版本负责人](https://github.com/kubernetes/sig-release/tree/master/release-team#kubernetes-release-team-roles)

0 commit comments

Comments
 (0)