Skip to content

Commit 844ff9d

Browse files
authored
Merge pull request #33744 from my-git9/mygit30
[zh] adjust format in docs/contribute
2 parents 5428061 + be5a636 commit 844ff9d

File tree

4 files changed

+26
-26
lines changed

4 files changed

+26
-26
lines changed

content/zh/docs/contribute/advanced.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ client and other tools for some of these tasks.
2323

2424
如果你已经了解如何[贡献新内容](/zh/docs/contribute/new-content/overview/)
2525
[评阅他人工作](/zh/docs/contribute/review/reviewing-prs/),并准备了解更多贡献的途径,
26-
请阅读此文。您需要使用 Git 命令行工具和其他工具做这些工作。
26+
请阅读此文。你需要使用 Git 命令行工具和其他工具做这些工作。
2727

2828
<!-- body -->
2929

content/zh/docs/contribute/generate-ref-docs/contribute-upstream.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ API or the `kube-*` components from the upstream code, see the following instruc
2727
- [Generating Reference Documentation for the Kubernetes API](/docs/contribute/generate-ref-docs/kubernetes-api/)
2828
- [Generating Reference Documentation for the Kubernetes Components and Tools](/docs/contribute/generate-ref-docs/kubernetes-components/)
2929
-->
30-
如果您仅想从上游代码重新生成 Kubernetes API 或 `kube-*` 组件的参考文档。请参考以下说明:
30+
如果你仅想从上游代码重新生成 Kubernetes API 或 `kube-*` 组件的参考文档。请参考以下说明:
3131

3232
- [生成 Kubernetes API 的参考文档](/zh/docs/contribute/generate-ref-docs/kubernetes-api/)
3333
- [生成 Kubernetes 组件和工具的参考文档](/zh/docs/contribute/generate-ref-docs/kubernetes-components/)
@@ -65,7 +65,7 @@ You need to have these tools installed:
6565
[Creating a Pull Request](https://help.github.com/articles/creating-a-pull-request/) and
6666
[GitHub Standard Fork & Pull Request Workflow](https://gist.github.com/Chaser324/ce0505fbed06b947d962).
6767
-->
68-
- 您需要知道如何创建对 GitHub 代码仓库的拉取请求(Pull Request)。
68+
- 你需要知道如何创建对 GitHub 代码仓库的拉取请求(Pull Request)。
6969
通常,这涉及创建代码仓库的派生副本。
7070
要获取更多的信息请参考[创建 PR](https://help.github.com/articles/creating-a-pull-request/)
7171
[GitHub 标准派生和 PR 工作流程](https://gist.github.com/Chaser324/ce0505fbed06b947d962)
@@ -87,7 +87,7 @@ creating a patch to fix it in the upstream project.
8787
Kubernetes API 和 `kube-*` 组件(例如 `kube-apiserver``kube-controller-manager`)的参考文档
8888
是根据[上游 Kubernetes](https://github.com/kubernetes/kubernetes/) 中的源代码自动生成的。
8989

90-
当您在生成的文档中看到错误时,您可能需要考虑创建一个 PR 用来在上游项目中对其进行修复。
90+
当你在生成的文档中看到错误时,你可能需要考虑创建一个 PR 用来在上游项目中对其进行修复。
9191

9292
<!--
9393
## Cloning the Kubernetes repository
@@ -96,7 +96,7 @@ If you don't already have the kubernetes/kubernetes repository, get it now:
9696
-->
9797
## 克隆 Kubernetes 代码仓库
9898

99-
如果您还没有 kubernetes/kubernetes 代码仓库,请参照下列命令获取:
99+
如果你还没有 kubernetes/kubernetes 代码仓库,请参照下列命令获取:
100100

101101
```shell
102102
mkdir $GOPATH/src
@@ -111,7 +111,7 @@ For example, if you followed the preceding step to get the repository, your
111111
base directory is `$GOPATH/src/github.com/kubernetes/kubernetes.`
112112
The remaining steps refer to your base directory as `<k8s-base>`.
113113
-->
114-
确定您的 [kubernetes/kubernetes](https://github.com/kubernetes/kubernetes) 代码仓库克隆的根目录。
114+
确定你的 [kubernetes/kubernetes](https://github.com/kubernetes/kubernetes) 代码仓库克隆的根目录。
115115
例如,如果按照前面的步骤获取代码仓库,则你的根目录为 `$GOPATH/src/github.com/kubernetes/kubernetes`
116116
接下来其余步骤将你的根目录称为 `<k8s-base>`
117117

@@ -122,7 +122,7 @@ For example, if you followed the preceding step to get the repository, your
122122
base directory is `$GOPATH/src/github.com/kubernetes-sigs/reference-docs.`
123123
The remaining steps refer to your base directory as `<rdocs-base>`.
124124
-->
125-
确定您的 [kubernetes-sigs/reference-docs](https://github.com/kubernetes-sigs/reference-docs)
125+
确定你的 [kubernetes-sigs/reference-docs](https://github.com/kubernetes-sigs/reference-docs)
126126
代码仓库克隆的根目录。
127127
例如,如果按照前面的步骤获取代码仓库,则你的根目录为
128128
`$GOPATH/src/github.com/kubernetes-sigs/reference-docs`
@@ -146,7 +146,7 @@ The documentation for the `kube-*` components is also generated from the upstrea
146146
source code. You must change the code related to the component
147147
you want to fix in order to fix the generated documentation.
148148
-->
149-
`kube-*` 组件的文档也是从上游源代码生成的。您必须更改与要修复的组件相关的代码,才能修复生成的文档。
149+
`kube-*` 组件的文档也是从上游源代码生成的。你必须更改与要修复的组件相关的代码,才能修复生成的文档。
150150

151151
<!--
152152
### Making changes to the upstream source code
@@ -168,7 +168,7 @@ and make sure it is up to date:
168168
-->
169169
以下在 Kubernetes 源代码中编辑注释的示例。
170170

171-
在您本地的 kubernetes/kubernetes 代码仓库中,检出默认分支,并确保它是最新的:
171+
在你本地的 kubernetes/kubernetes 代码仓库中,检出默认分支,并确保它是最新的:
172172

173173
```shell
174174
cd <k8s-base>
@@ -200,7 +200,7 @@ git status
200200
The output shows that you are on the master branch, and that the `types.go`
201201
source file has been modified:
202202
-->
203-
输出显示您在 master 分支上,`types.go` 源文件已被修改:
203+
输出显示你在 master 分支上,`types.go` 源文件已被修改:
204204

205205
```shell
206206
On branch master
@@ -217,7 +217,7 @@ you will do a second commit. It is important to keep your changes separated into
217217
### 提交已编辑的文件
218218

219219
运行 `git add``git commit` 命令提交到目前为止所做的更改。
220-
在下一步中,您将进行第二次提交,将更改分成两个提交很重要。
220+
在下一步中,你将进行第二次提交,将更改分成两个提交很重要。
221221

222222
<!--
223223
### Generating the OpenAPI spec and related files
@@ -254,17 +254,17 @@ This is important, because `swagger.json` is the input to the second stage of
254254
the doc generation process.
255255
-->
256256
查看 `api/openapi-spec/swagger.json` 的内容,以确保拼写错误已经被修正。
257-
例如,您可以运行 `git diff -a api/openapi-spec/swagger.json` 命令。
257+
例如,你可以运行 `git diff -a api/openapi-spec/swagger.json` 命令。
258258
这很重要,因为 `swagger.json` 是文档生成过程中第二阶段的输入。
259259

260260
<!--
261261
Run `git add` and `git commit` to commit your changes. Now you have two commits:
262262
one that contains the edited `types.go` file, and one that contains the generated OpenAPI spec
263263
and related files. Keep these two commits separate. That is, do not squash your commits.
264264
-->
265-
运行 `git add``git commit` 命令来提交您的更改。现在您有两个提交(commits):
265+
运行 `git add``git commit` 命令来提交你的更改。现在你有两个提交(commits):
266266
一种包含编辑的 `types.go` 文件,另一种包含生成的 OpenAPI 规范和相关文件。
267-
将这两个提交分开独立。也就是说,不要 squash 您的提交
267+
将这两个提交分开独立。也就是说,不要 squash 你的提交
268268

269269
<!--
270270
Submit your changes as a
@@ -274,9 +274,9 @@ master branch of the
274274
Monitor your pull request, and respond to reviewer comments as needed. Continue
275275
to monitor your pull request until it is merged.
276276
-->
277-
将您的更改作为 [PR](https://help.github.com/articles/creating-a-pull-request/)
277+
将你的更改作为 [PR](https://help.github.com/articles/creating-a-pull-request/)
278278
提交到 [kubernetes/kubernetes](https://github.com/kubernetes/kubernetes) 代码仓库的 master 分支。
279-
关注您的 PR,并根据需要回复 reviewer 的评论。继续关注您的 PR,直到 PR 被合并为止。
279+
关注你的 PR,并根据需要回复 reviewer 的评论。继续关注你的 PR,直到 PR 被合并为止。
280280

281281
<!--
282282
[PR 57758](https://github.com/kubernetes/kubernetes/pull/57758)
@@ -297,7 +297,7 @@ repository and in related repositories, such as
297297
-->
298298
{{< note >}}
299299
确定要更改的正确源文件可能很棘手。在前面的示例中,官方的源文件位于 `kubernetes/kubernetes`
300-
代码仓库的 `staging` 目录中。但是根据您的情况`staging` 目录可能不是找到官方源文件的地方。
300+
代码仓库的 `staging` 目录中。但是根据你的情况`staging` 目录可能不是找到官方源文件的地方。
301301
如果需要帮助,请阅读
302302
[kubernetes/kubernetes](https://github.com/kubernetes/kubernetes/tree/master/staging)
303303
代码仓库和相关代码仓库
@@ -330,7 +330,7 @@ commit into the release-{{< skew prevMinorVersion >}} branch. The idea is to che
330330
that edited `types.go`, but not the commit that has the results of running the scripts. For instructions, see
331331
[Propose a Cherry Pick](https://git.k8s.io/community/contributors/devel/sig-release/cherry-picks.md).
332332
-->
333-
回想一下,您的 PR 有两个提交:一个用于编辑 `types.go`,一个用于由脚本生成的文件。
333+
回想一下,你的 PR 有两个提交:一个用于编辑 `types.go`,一个用于由脚本生成的文件。
334334
下一步是将你的第一次提交 cherrypick 到 release-{{< skew prevMinorVersion >}} 分支。
335335
这样做的原因是仅 cherrypick 编辑了 types.go 的提交,
336336
而不是具有脚本运行结果的提交。
@@ -366,7 +366,7 @@ Now add a commit to your cherry-pick pull request that has the recently generate
366366
and related files. Monitor your pull request until it gets merged into the
367367
release-{{< skew prevMinorVersion >}} branch.
368368
-->
369-
现在将提交添加到您的 Cherry-Pick PR 中,该 PR 中包含最新生成的 OpenAPI 规范和相关文件。
369+
现在将提交添加到你的 Cherry-Pick PR 中,该 PR 中包含最新生成的 OpenAPI 规范和相关文件。
370370
关注你的 PR,直到其合并到 release-{{< skew prevMinorVersion >}} 分支中为止。
371371

372372
<!--
@@ -405,7 +405,7 @@ the API reference documentation.
405405
You are now ready to follow the [Generating Reference Documentation for the Kubernetes API](/docs/contribute/generate-ref-docs/kubernetes-api/) guide to generate the
406406
[published Kubernetes API reference documentation](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/).
407407
-->
408-
现在,您可以按照
408+
现在,你可以按照
409409
[生成 Kubernetes API 的参考文档](/zh/docs/contribute/generate-ref-docs/kubernetes-api/)
410410
指南来生成
411411
[已发布的 Kubernetes API 参考文档](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/)。

content/zh/docs/contribute/generate-ref-docs/kubectl.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ go get -u kubernetes-incubator/reference-docs
7272
<!--
7373
If you don't already have the kubernetes/website repository, get it now:
7474
-->
75-
如果您还没有获取过 `kubernetes/website` 仓库,现在获取之:
75+
如果你还没有获取过 `kubernetes/website` 仓库,现在获取之:
7676

7777
```shell
7878
git clone https://github.com/<your-username>/website $GOPATH/src/github.com/<your-username>/website
@@ -242,7 +242,7 @@ For example, update the following variables:
242242
* 设置 `K8S_ROOT``<k8s-base>`
243243
* 设置 `K8S_WEBROOT``<web-base>`
244244
* 设置 `K8S_RELEASE` 为要构建文档的版本。
245-
例如,如果您想为 Kubernetes {{< skew prevMinorVersion >}} 构建文档,
245+
例如,如果你想为 Kubernetes {{< skew prevMinorVersion >}} 构建文档,
246246
请将 `K8S_RELEASE` 设置为 {{< skew prevMinorVersion >}}。
247247

248248
例如:

content/zh/docs/contribute/generate-ref-docs/kubernetes-api.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ Kubernetes API 参考文档是从
3131
构建的,
3232
且使用[kubernetes-sigs/reference-docs](https://github.com/kubernetes-sigs/reference-docs) 生成代码。
3333

34-
如果您在生成的文档中发现错误,则需要[在上游修复](/zh/docs/contribute/generate-ref-docs/contribute-upstream/)
34+
如果你在生成的文档中发现错误,则需要[在上游修复](/zh/docs/contribute/generate-ref-docs/contribute-upstream/)
3535

36-
如果您只需要从 [OpenAPI](https://github.com/OAI/OpenAPI-Specification) 规范中重新生成参考文档,请继续阅读此页。
36+
如果你只需要从 [OpenAPI](https://github.com/OAI/OpenAPI-Specification) 规范中重新生成参考文档,请继续阅读此页。
3737

3838
## {{% heading "prerequisites" %}}
3939

@@ -135,7 +135,7 @@ Go to `<rdocs-base>`, and open the `Makefile` for editing:
135135
* 设置 `K8S_ROOT``<k8s-base>`.
136136
* 设置 `K8S_WEBROOT``<web-base>`.
137137
* 设置 `K8S_RELEASE` 为要构建的文档的版本。
138-
例如,如果您想为 Kubernetes 1.17.0 构建文档,请将 `K8S_RELEASE` 设置为 1.17.0。
138+
例如,如果你想为 Kubernetes 1.17.0 构建文档,请将 `K8S_RELEASE` 设置为 1.17.0。
139139

140140
<!--
141141
For example:
@@ -307,7 +307,7 @@ to monitor your pull request until it has been merged.
307307
-->
308308
基于你所生成的更改[创建 PR](/zh/docs/contribute/new-content/open-a-pr/)
309309
提交到 [kubernetes/website](https://github.com/kubernetes/website) 仓库。
310-
监视您提交的 PR,并根据需要回复 reviewer 的评论。继续监视您的 PR,直到合并为止。
310+
监视你提交的 PR,并根据需要回复 reviewer 的评论。继续监视你的 PR,直到合并为止。
311311

312312
## {{% heading "whatsnext" %}}
313313

0 commit comments

Comments
 (0)