Merge pull request #34508 from howieyuen/concept-pages-5

[zh]Update contribute pages for links with '/zh/' prefix, using new prefix '/zh-cn/'
This commit is contained in:
Kubernetes Prow Robot
2022-06-23 18:17:19 -07:00
committed by GitHub
21 changed files with 116 additions and 116 deletions
@@ -22,5 +22,5 @@ To build the reference documentation, see the following guide:
本节的主题是描述如何生成 Kubernetes 参考指南。 本节的主题是描述如何生成 Kubernetes 参考指南。
要生成参考文档,请参考下面的指南: 要生成参考文档,请参考下面的指南:
* [生成参考文档快速入门](/zh/docs/contribute/generate-ref-docs/quickstart/) * [生成参考文档快速入门](/zh-cn/docs/contribute/generate-ref-docs/quickstart/)
@@ -29,8 +29,8 @@ API or the `kube-*` components from the upstream code, see the following instruc
--> -->
如果你仅想从上游代码重新生成 Kubernetes API 或 `kube-*` 组件的参考文档。请参考以下说明: 如果你仅想从上游代码重新生成 Kubernetes API 或 `kube-*` 组件的参考文档。请参考以下说明:
- [生成 Kubernetes API 的参考文档](/zh/docs/contribute/generate-ref-docs/kubernetes-api/) - [生成 Kubernetes API 的参考文档](/zh-cn/docs/contribute/generate-ref-docs/kubernetes-api/)
- [生成 Kubernetes 组件和工具的参考文档](/zh/docs/contribute/generate-ref-docs/kubernetes-components/) - [生成 Kubernetes 组件和工具的参考文档](/zh-cn/docs/contribute/generate-ref-docs/kubernetes-components/)
## {{% heading "prerequisites" %}} ## {{% heading "prerequisites" %}}
@@ -406,7 +406,7 @@ You are now ready to follow the [Generating Reference Documentation for the Kube
[published Kubernetes API reference documentation](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/). [published Kubernetes API reference documentation](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/).
--> -->
现在,你可以按照 现在,你可以按照
[生成 Kubernetes API 的参考文档](/zh/docs/contribute/generate-ref-docs/kubernetes-api/) [生成 Kubernetes API 的参考文档](/zh-cn/docs/contribute/generate-ref-docs/kubernetes-api/)
指南来生成 指南来生成
[已发布的 Kubernetes API 参考文档](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/)。 [已发布的 Kubernetes API 参考文档](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/)。
@@ -417,7 +417,7 @@ You are now ready to follow the [Generating Reference Documentation for the Kube
* [Generating Reference Docs for Kubernetes Components and Tools](/docs/home/contribute/generated-reference/kubernetes-components/) * [Generating Reference Docs for Kubernetes Components and Tools](/docs/home/contribute/generated-reference/kubernetes-components/)
* [Generating Reference Documentation for kubectl Commands](/docs/home/contribute/generated-reference/kubectl/) * [Generating Reference Documentation for kubectl Commands](/docs/home/contribute/generated-reference/kubectl/)
--> -->
* [生成 Kubernetes API 的参考文档](/zh/docs/contribute/generate-ref-docs/kubernetes-api/) * [生成 Kubernetes API 的参考文档](/zh-cn/docs/contribute/generate-ref-docs/kubernetes-api/)
* [为 Kubernetes 组件和工具生成参考文档](/zh/docs/contribute/generate-ref-docs/kubernetes-components/) * [为 Kubernetes 组件和工具生成参考文档](/zh-cn/docs/contribute/generate-ref-docs/kubernetes-components/)
* [生成 kubectl 命令的参考文档](/zh/docs/contribute/generate-ref-docs/kubectl/) * [生成 kubectl 命令的参考文档](/zh-cn/docs/contribute/generate-ref-docs/kubectl/)
@@ -36,7 +36,7 @@ reference page, see
生成参考文档,如 [kubectl apply](/docs/reference/generated/kubectl/kubectl-commands#apply) 和 生成参考文档,如 [kubectl apply](/docs/reference/generated/kubectl/kubectl-commands#apply) 和
[kubectl taint](/docs/reference/generated/kubectl/kubectl-commands#taint)。 [kubectl taint](/docs/reference/generated/kubectl/kubectl-commands#taint)。
本主题没有讨论如何生成 [kubectl](/docs/reference/generated/kubectl/kubectl-commands/) 组件选项的参考页面。 本主题没有讨论如何生成 [kubectl](/docs/reference/generated/kubectl/kubectl-commands/) 组件选项的参考页面。
相关说明请参见[为 Kubernetes 组件和工具生成参考页面](/zh/docs/contribute/generate-ref-docs/kubernetes-components/)。 相关说明请参见[为 Kubernetes 组件和工具生成参考页面](/zh-cn/docs/contribute/generate-ref-docs/kubernetes-components/)。
{{< /note >}} {{< /note >}}
## {{% heading "prerequisites" %}} ## {{% heading "prerequisites" %}}
@@ -416,7 +416,7 @@ topics will be visible in the
`kubernetes/website` 仓库创建 PR。跟踪你的 PR,并根据需要回应评审人的评论。 `kubernetes/website` 仓库创建 PR。跟踪你的 PR,并根据需要回应评审人的评论。
继续跟踪你的 PR,直到它被合入。 继续跟踪你的 PR,直到它被合入。
在 PR 合入的几分钟后,你更新的参考主题将出现在[已发布文档](/zh/docs/home/)中。 在 PR 合入的几分钟后,你更新的参考主题将出现在[已发布文档](/zh-cn/docs/home/)中。
## {{% heading "whatsnext" %}} ## {{% heading "whatsnext" %}}
@@ -425,7 +425,7 @@ topics will be visible in the
* [Generating Reference Documentation for Kubernetes Components and Tools](/docs/contribute/generate-ref-docs/kubernetes-components/) * [Generating Reference Documentation for Kubernetes Components and Tools](/docs/contribute/generate-ref-docs/kubernetes-components/)
* [Generating Reference Documentation for the Kubernetes API](/docs/contribute/generate-ref-docs/kubernetes-api/) * [Generating Reference Documentation for the Kubernetes API](/docs/contribute/generate-ref-docs/kubernetes-api/)
--> -->
* [生成参考文档快速入门](/zh/docs/contribute/generate-ref-docs/quickstart/) * [生成参考文档快速入门](/zh-cn/docs/contribute/generate-ref-docs/quickstart/)
* [为 Kubernetes 组件和工具生成参考文档](/zh/docs/contribute/generate-ref-docs/kubernetes-components/) * [为 Kubernetes 组件和工具生成参考文档](/zh-cn/docs/contribute/generate-ref-docs/kubernetes-components/)
* [为 Kubernetes API 生成参考文档](/zh/docs/contribute/generate-ref-docs/kubernetes-api/) * [为 Kubernetes API 生成参考文档](/zh-cn/docs/contribute/generate-ref-docs/kubernetes-api/)
@@ -31,7 +31,7 @@ Kubernetes API 参考文档是从
构建的, 构建的,
且使用[kubernetes-sigs/reference-docs](https://github.com/kubernetes-sigs/reference-docs) 生成代码。 且使用[kubernetes-sigs/reference-docs](https://github.com/kubernetes-sigs/reference-docs) 生成代码。
如果你在生成的文档中发现错误,则需要[在上游修复](/zh/docs/contribute/generate-ref-docs/contribute-upstream/)。 如果你在生成的文档中发现错误,则需要[在上游修复](/zh-cn/docs/contribute/generate-ref-docs/contribute-upstream/)。
如果你只需要从 [OpenAPI](https://github.com/OAI/OpenAPI-Specification) 规范中重新生成参考文档,请继续阅读此页。 如果你只需要从 [OpenAPI](https://github.com/OAI/OpenAPI-Specification) 规范中重新生成参考文档,请继续阅读此页。
@@ -305,7 +305,7 @@ Submit your changes as a
Monitor your pull request, and respond to reviewer comments as needed. Continue Monitor your pull request, and respond to reviewer comments as needed. Continue
to monitor your pull request until it has been merged. to monitor your pull request until it has been merged.
--> -->
基于你所生成的更改[创建 PR](/zh/docs/contribute/new-content/open-a-pr/) 基于你所生成的更改[创建 PR](/zh-cn/docs/contribute/new-content/open-a-pr/)
提交到 [kubernetes/website](https://github.com/kubernetes/website) 仓库。 提交到 [kubernetes/website](https://github.com/kubernetes/website) 仓库。
监视你提交的 PR,并根据需要回复 reviewer 的评论。继续监视你的 PR,直到合并为止。 监视你提交的 PR,并根据需要回复 reviewer 的评论。继续监视你的 PR,直到合并为止。
@@ -316,7 +316,7 @@ to monitor your pull request until it has been merged.
* [Generating Reference Docs for Kubernetes Components and Tools](/docs/contribute/generate-ref-docs/kubernetes-components/) * [Generating Reference Docs for Kubernetes Components and Tools](/docs/contribute/generate-ref-docs/kubernetes-components/)
* [Generating Reference Documentation for kubectl Commands](/docs/contribute/generate-ref-docs/kubectl/) * [Generating Reference Documentation for kubectl Commands](/docs/contribute/generate-ref-docs/kubectl/)
--> -->
* [生成参考文档快速入门](/zh/docs/contribute/generate-ref-docs/quickstart/) * [生成参考文档快速入门](/zh-cn/docs/contribute/generate-ref-docs/quickstart/)
* [为 Kubernetes 组件和工具生成参考文档](/zh/docs/contribute/generate-ref-docs/kubernetes-components/) * [为 Kubernetes 组件和工具生成参考文档](/zh-cn/docs/contribute/generate-ref-docs/kubernetes-components/)
* [为 kubectl 命令集生成参考文档](/zh/docs/contribute/generate-ref-docs/kubectl/) * [为 kubectl 命令集生成参考文档](/zh-cn/docs/contribute/generate-ref-docs/kubectl/)
@@ -23,7 +23,7 @@ This page shows how to build the Kubernetes component and tool reference pages.
Start with the [Prerequisites section](/docs/contribute/generate-ref-docs/quickstart/#before-you-begin) Start with the [Prerequisites section](/docs/contribute/generate-ref-docs/quickstart/#before-you-begin)
in the Reference Documentation Quickstart guide. in the Reference Documentation Quickstart guide.
--> -->
阅读参考文档快速入门指南中的[准备工作](/zh/docs/contribute/generate-ref-docs/quickstart/#before-you-begin)节。 阅读参考文档快速入门指南中的[准备工作](/zh-cn/docs/contribute/generate-ref-docs/quickstart/#before-you-begin)节。
<!-- steps --> <!-- steps -->
@@ -31,7 +31,7 @@ in the Reference Documentation Quickstart guide.
Follow the [Reference Documentation Quickstart](/docs/contribute/generate-ref-docs/quickstart/) Follow the [Reference Documentation Quickstart](/docs/contribute/generate-ref-docs/quickstart/)
to generate the Kubernetes component and tool reference pages. to generate the Kubernetes component and tool reference pages.
--> -->
按照[参考文档快速入门](/zh/docs/contribute/generate-ref-docs/quickstart/) 按照[参考文档快速入门](/zh-cn/docs/contribute/generate-ref-docs/quickstart/)
指引,生成 Kubernetes 组件和工具的参考文档。 指引,生成 Kubernetes 组件和工具的参考文档。
## {{% heading "whatsnext" %}} ## {{% heading "whatsnext" %}}
@@ -43,8 +43,8 @@ to generate the Kubernetes component and tool reference pages.
* [Contributing to the Upstream Kubernetes Project for Documentation](/docs/contribute/generate-ref-docs/contribute-upstream/) * [Contributing to the Upstream Kubernetes Project for Documentation](/docs/contribute/generate-ref-docs/contribute-upstream/)
--> -->
* [生成参考文档快速入门](/zh/docs/contribute/generate-ref-docs/quickstart/) * [生成参考文档快速入门](/zh-cn/docs/contribute/generate-ref-docs/quickstart/)
* [为 kubectll 命令生成参考文档](/zh/docs/contribute/generate-ref-docs/kubectl/) * [为 kubectll 命令生成参考文档](/zh-cn/docs/contribute/generate-ref-docs/kubectl/)
* [为 Kubernetes API 生成参考文档](/zh/docs/contribute/generate-ref-docs/kubernetes-api/) * [为 Kubernetes API 生成参考文档](/zh-cn/docs/contribute/generate-ref-docs/kubernetes-api/)
* [为上游 Kubernetes 项目做贡献以改进文档](/zh/docs/contribute/generate-ref-docs/contribute-upstream/) * [为上游 Kubernetes 项目做贡献以改进文档](/zh-cn/docs/contribute/generate-ref-docs/contribute-upstream/)
@@ -41,5 +41,5 @@
- 你需要知道如何为一个 GitHub 仓库创建拉取请求(PR)。 - 你需要知道如何为一个 GitHub 仓库创建拉取请求(PR)。
这牵涉到创建仓库的派生(fork)副本。 这牵涉到创建仓库的派生(fork)副本。
有关信息可进一步查看[基于本地副本开展工作](/zh/docs/contribute/new-content/open-a-pr/#fork-the-repo)。 有关信息可进一步查看[基于本地副本开展工作](/zh-cn/docs/contribute/new-content/open-a-pr/#fork-the-repo)。
@@ -57,7 +57,7 @@ see the [contributing upstream guide](/docs/contribute/generate-ref-docs/contrib
{{< note>}} {{< note>}}
如果你希望更改构建工具和 API 参考资料,可以阅读 如果你希望更改构建工具和 API 参考资料,可以阅读
[上游贡献指南](/zh/docs/contribute/generate-ref-docs/contribute-upstream). [上游贡献指南](/zh-cn/docs/contribute/generate-ref-docs/contribute-upstream).
{{< /note >}} {{< /note >}}
<!-- <!--
@@ -185,7 +185,7 @@ Single page Markdown documents, imported by the tool, must adhere to
the [Documentation Style Guide](/docs/contribute/style/style-guide/). the [Documentation Style Guide](/docs/contribute/style/style-guide/).
--> -->
通过工具导入的单页面的 Markdown 文档必须遵从 通过工具导入的单页面的 Markdown 文档必须遵从
[文档样式指南](/zh/docs/contribute/style/style-guide/)。 [文档样式指南](/zh-cn/docs/contribute/style/style-guide/)。
<!-- <!--
## Customizing reference.yml ## Customizing reference.yml
@@ -385,7 +385,7 @@ topics will be visible in the
继续监视该 PR 直到其被合并为止。 继续监视该 PR 直到其被合并为止。
当你的 PR 被合并几分钟之后,你所做的对参考文档的变更就会出现 当你的 PR 被合并几分钟之后,你所做的对参考文档的变更就会出现
[发布的文档](/zh/docs/home/)上。 [发布的文档](/zh-cn/docs/home/)上。
## {{% heading "whatsnext" %}} ## {{% heading "whatsnext" %}}
@@ -399,7 +399,7 @@ running the build targets, see the following guides:
--> -->
要手动设置所需的构造仓库,执行构建目标,以生成各个参考文档,可参考下面的指南: 要手动设置所需的构造仓库,执行构建目标,以生成各个参考文档,可参考下面的指南:
* [为 Kubernetes 组件和工具生成参考文档](/zh/docs/contribute/generate-ref-docs/kubernetes-components/) * [为 Kubernetes 组件和工具生成参考文档](/zh-cn/docs/contribute/generate-ref-docs/kubernetes-components/)
* [为 kubectl 命令生成参考文档](/zh/docs/contribute/generate-ref-docs/kubectl/) * [为 kubectl 命令生成参考文档](/zh-cn/docs/contribute/generate-ref-docs/kubectl/)
* [为 Kubernetes API 生成参考文档](/zh/docs/contribute/generate-ref-docs/kubernetes-api/) * [为 Kubernetes API 生成参考文档](/zh-cn/docs/contribute/generate-ref-docs/kubernetes-api/)
@@ -73,7 +73,7 @@ The website content directory includes sub-directories for each language. The lo
### 派生(fork)并且克隆仓库 {#fork-and-clone-the-repo} ### 派生(fork)并且克隆仓库 {#fork-and-clone-the-repo}
首先,为 [kubernetes/website](https://github.com/kubernetes/website) 仓库 首先,为 [kubernetes/website](https://github.com/kubernetes/website) 仓库
[创建你自己的副本](/zh/docs/contribute/new-content/open-a-pr/#fork-the-repo)。 [创建你自己的副本](/zh-cn/docs/contribute/new-content/open-a-pr/#fork-the-repo)。
<!-- <!--
Then, clone your fork and `cd` into it: Then, clone your fork and `cd` into it:
@@ -116,7 +116,7 @@ that localization. The process is very similar to proposing changes to the upstr
请将拉取请求限制为单个本地化,因为在多个本地化中更改内容的拉取请求可能难以审查。 请将拉取请求限制为单个本地化,因为在多个本地化中更改内容的拉取请求可能难以审查。
按照[内容改进建议](/zh/docs/contribute/suggest-improvements/)提出对该本地化的更改。 按照[内容改进建议](/zh-cn/docs/contribute/suggest-improvements/)提出对该本地化的更改。
该过程与提议更改上游(英文)内容非常相似。 该过程与提议更改上游(英文)内容非常相似。
<!-- <!--
@@ -434,7 +434,7 @@ For an example of adding a new localization, see the PR to enable [docs in Frenc
--> -->
### 打开拉取请求 {#open-a-pull-request} ### 打开拉取请求 {#open-a-pull-request}
接下来,[打开拉取请求](/zh/docs/contribute/new-content/open-a-pr/#open-a-pr)PR 接下来,[打开拉取请求](/zh-cn/docs/contribute/new-content/open-a-pr/#open-a-pr)PR
将本地化添加到 `kubernetes/website` 存储库。 将本地化添加到 `kubernetes/website` 存储库。
PR 必须包含所有[最低要求内容](#minimum-required-content)才能获得批准。 PR 必须包含所有[最低要求内容](#minimum-required-content)才能获得批准。
@@ -515,9 +515,9 @@ Releases | [All heading and subheading URLs](/releases)
--> -->
描述 | 网址 描述 | 网址
-----|----- -----|-----
主页 | [所有标题和副标题网址](/zh/docs/home/) 主页 | [所有标题和副标题网址](/zh-cn/docs/home/)
安装 | [所有标题和副标题网址](/zh/docs/setup/) 安装 | [所有标题和副标题网址](/zh-cn/docs/setup/)
教程 | [Kubernetes 基础](/zh/docs/tutorials/kubernetes-basics/), [Hello Minikube](/zh/docs/tutorials/hello-minikube/) 教程 | [Kubernetes 基础](/zh-cn/docs/tutorials/kubernetes-basics/), [Hello Minikube](/zh-cn/docs/tutorials/hello-minikube/)
网站字符串 | [所有网站字符串](#Site-strings-in-i18n) 网站字符串 | [所有网站字符串](#Site-strings-in-i18n)
发行版本 | [所有标题和副标题 URL](/releases) 发行版本 | [所有标题和副标题 URL](/releases)
@@ -525,7 +525,7 @@ Releases | [All heading and subheading URLs](/releases)
Translated documents must reside in their own `content/**/` subdirectory, but otherwise follow the same URL path as the English source. For example, to prepare the [Kubernetes Basics](/docs/tutorials/kubernetes-basics/) tutorial for translation into German, create a subfolder under the `content/de/` folder and copy the English source: Translated documents must reside in their own `content/**/` subdirectory, but otherwise follow the same URL path as the English source. For example, to prepare the [Kubernetes Basics](/docs/tutorials/kubernetes-basics/) tutorial for translation into German, create a subfolder under the `content/de/` folder and copy the English source:
--> -->
翻译后的文档必须保存在自己的 `content/**/` 子目录中,否则将遵循与英文源相同的 URL 路径。 翻译后的文档必须保存在自己的 `content/**/` 子目录中,否则将遵循与英文源相同的 URL 路径。
例如,要准备将 [Kubernetes 基础](/zh/docs/tutorials/kubernetes-basics/) 教程翻译为德语, 例如,要准备将 [Kubernetes 基础](/zh-cn/docs/tutorials/kubernetes-basics/) 教程翻译为德语,
请在 `content/de/` 文件夹下创建一个子文件夹并复制英文源: 请在 `content/de/` 文件夹下创建一个子文件夹并复制英文源:
```shell ```shell
@@ -634,7 +634,7 @@ Some language teams have their own language-specific style guide and glossary. F
### 特定语言的样式指南和词汇表 {#language-specific-style-guide-and-glossary} ### 特定语言的样式指南和词汇表 {#language-specific-style-guide-and-glossary}
一些语言团队有自己的特定语言样式指南和词汇表。 一些语言团队有自己的特定语言样式指南和词汇表。
例如,请参见[中文本地化指南](/zh/docs/contribute/localization_zh/)。 例如,请参见[中文本地化指南](/zh-cn/docs/contribute/localization_zh/)。
<!-- <!--
### Language specific Zoom meetings ### Language specific Zoom meetings
@@ -84,9 +84,9 @@ prior to submitting new content. The information details follow.
- 使用 Markdown 编写 Kubernetes 文档并使用 [Hugo](https://gohugo.io/) 构建网站。 - 使用 Markdown 编写 Kubernetes 文档并使用 [Hugo](https://gohugo.io/) 构建网站。
- Kubernetes 文档使用 [CommonMark](https://commonmark.org/) 作为 Markdown 的风格。 - Kubernetes 文档使用 [CommonMark](https://commonmark.org/) 作为 Markdown 的风格。
- 源代码位于 [GitHub](https://github.com/kubernetes/website) 仓库中。 - 源代码位于 [GitHub](https://github.com/kubernetes/website) 仓库中。
你可以在 `/content/zh/docs/` 目录下找到 Kubernetes 文档。 你可以在 `/content/zh-cn/docs/` 目录下找到 Kubernetes 文档。
某些参考文档是使用位于 `update-imported-docs/` 目录下的脚本自动生成的。 某些参考文档是使用位于 `update-imported-docs/` 目录下的脚本自动生成的。
- [页面内容类型](/zh/docs/contribute/style/page-content-types/)使用 Hugo 描述文档内容的呈现。 - [页面内容类型](/zh-cn/docs/contribute/style/page-content-types/)使用 Hugo 描述文档内容的呈现。
<!-- <!--
- You can use [Docsy shortcodes](https://www.docsy.dev/docs/adding-content/shortcodes/) or [custom Hugo shortcodes](/docs/contribute/style/hugo-shortcodes/) to contribute to Kubernetes documentation. - You can use [Docsy shortcodes](https://www.docsy.dev/docs/adding-content/shortcodes/) or [custom Hugo shortcodes](/docs/contribute/style/hugo-shortcodes/) to contribute to Kubernetes documentation.
@@ -103,15 +103,15 @@ prior to submitting new content. The information details follow.
--> -->
- 你可以使用 [Docsy 短代码](https://www.docsy.dev/docs/adding-content/shortcodes/) - 你可以使用 [Docsy 短代码](https://www.docsy.dev/docs/adding-content/shortcodes/)
或[定制的 Hugo 短代码](/zh/docs/contribute/style/hugo-shortcodes/)贡献 Kubernetes 文档。 或[定制的 Hugo 短代码](/zh-cn/docs/contribute/style/hugo-shortcodes/)贡献 Kubernetes 文档。
- 除了标准的 Hugo 短代码外, - 除了标准的 Hugo 短代码外,
我们还在文档中使用一些[定制的 Hugo 短代码](/zh/docs/contribute/style/hugo-shortcodes/)来控制内容的呈现。 我们还在文档中使用一些[定制的 Hugo 短代码](/zh-cn/docs/contribute/style/hugo-shortcodes/)来控制内容的呈现。
- 文档的源代码有多种语言形式,位于 `/content/` 目录下。 - 文档的源代码有多种语言形式,位于 `/content/` 目录下。
每种语言都有一个自己的目录,用两个字母表示,这两个字母是基于 每种语言都有一个自己的目录,用两个字母表示,这两个字母是基于
[ISO 639-1 标准](https://www.loc.gov/standards/iso639-2/php/code_list.php)来确定的。 [ISO 639-1 标准](https://www.loc.gov/standards/iso639-2/php/code_list.php)来确定的。
例如,英语文档的源代码位于 `/content/en/docs/` 目录下。 例如,英语文档的源代码位于 `/content/en/docs/` 目录下。
- 关于为多语言文档做贡献以及如何开始新翻译的详细信息, - 关于为多语言文档做贡献以及如何开始新翻译的详细信息,
可参考[本地化文档](/zh/docs/contribute/localization)。 可参考[本地化文档](/zh-cn/docs/contribute/localization)。
<!-- <!--
## Before you begin {#before-you-begin} ## Before you begin {#before-you-begin}
@@ -159,7 +159,7 @@ If you're still not sure which branch to choose, ask in `#sig-docs` on Slack.
:---------|:------------ :---------|:------------
针对当前发行版本的,对现有英文内容的修改或新的英文内容 | `main` 针对当前发行版本的,对现有英文内容的修改或新的英文内容 | `main`
针对功能特性变更的内容 | 分支对应于功能特性变更的主要和次要版本,分支名称采用 `dev-<version>` 的模式。例如,如果某功能特性在 `v{{< skew nextMinorVersion >}}` 版本发生变化,则对应的文档变化要添加到 `dev-{{< skew nextMinorVersion >}}` 分支。 针对功能特性变更的内容 | 分支对应于功能特性变更的主要和次要版本,分支名称采用 `dev-<version>` 的模式。例如,如果某功能特性在 `v{{< skew nextMinorVersion >}}` 版本发生变化,则对应的文档变化要添加到 `dev-{{< skew nextMinorVersion >}}` 分支。
其他语言的内容(本地化) | 基于本地化团队的约定。参见[本地化分支策略](/zh/docs/contribute/localization/#branching-strategy)了解更多信息。 其他语言的内容(本地化) | 基于本地化团队的约定。参见[本地化分支策略](/zh-cn/docs/contribute/localization/#branching-strategy)了解更多信息。
如果你仍不能确定要选择哪个分支,请在 Slack 的 `#sig-docs` 频道上提出问题。 如果你仍不能确定要选择哪个分支,请在 Slack 的 `#sig-docs` 频道上提出问题。
@@ -196,5 +196,5 @@ contribution journey go more smoothly.
## 为贡献者提供的工具 ## 为贡献者提供的工具
`kubernetes/website` 仓库的[文档贡献者工具](https://github.com/kubernetes/website/tree/main/content/zh/docs/doc-contributor-tools)目录中包含了一些工具, `kubernetes/website` 仓库的[文档贡献者工具](https://github.com/kubernetes/website/tree/main/content/zh-cn/docs/doc-contributor-tools)目录中包含了一些工具,
有助于使你的贡献过程更为顺畅。 有助于使你的贡献过程更为顺畅。
@@ -119,7 +119,7 @@ To submit a blog post, follow these steps:
- 博客内容不可以是销售用语。 - 博客内容不可以是销售用语。
- 文章内容必须是对整个 Kubernetes 社区中很多人都有参考意义。 - 文章内容必须是对整个 Kubernetes 社区中很多人都有参考意义。
例如,所提交的文章应该关注上游的 Kubernetes 项目本身,而不是某个厂商特定的配置。 例如,所提交的文章应该关注上游的 Kubernetes 项目本身,而不是某个厂商特定的配置。
请参阅[文档风格指南](/zh/docs/contribute/style/content-guide/#what-s-allowed) 请参阅[文档风格指南](/zh-cn/docs/contribute/style/content-guide/#what-s-allowed)
以了解哪些内容是 Kubernetes 所允许的。 以了解哪些内容是 Kubernetes 所允许的。
- 链接应该主要指向官方的 Kubernetes 文档。 - 链接应该主要指向官方的 Kubernetes 文档。
当引用外部信息时,链接应该是多样的。 当引用外部信息时,链接应该是多样的。
@@ -217,7 +217,7 @@ SIG Docs [博客子项目](https://github.com/kubernetes/community/tree/master/s
- Do **not** include dots in the filename. A name like `2020-01-01-whats-new-in-1.19.md` causes failures during a build. - Do **not** include dots in the filename. A name like `2020-01-01-whats-new-in-1.19.md` causes failures during a build.
- The front matter must include the following: - The front matter must include the following:
--> -->
- [发起一个包含新博文的 PR](/zh/docs/contribute/new-content/open-a-pr/#fork-the-repo)。 - [发起一个包含新博文的 PR](/zh-cn/docs/contribute/new-content/open-a-pr/#fork-the-repo)。
新博文要创建于 [`content/en/blog/_posts`](https://github.com/kubernetes/website/tree/main/content/en/blog/_posts) 目录下。 新博文要创建于 [`content/en/blog/_posts`](https://github.com/kubernetes/website/tree/main/content/en/blog/_posts) 目录下。
- 确保你的博文遵从合适的命名规范,并带有下面的引言(元数据)信息: - 确保你的博文遵从合适的命名规范,并带有下面的引言(元数据)信息:
@@ -64,7 +64,7 @@ the techniques described in
在你选定了某个功能特性,为其撰写文档(主笔或辅助),请在 `#sig-docs` Slack 频道、SIG Docs 的每周例会上, 在你选定了某个功能特性,为其撰写文档(主笔或辅助),请在 `#sig-docs` Slack 频道、SIG Docs 的每周例会上,
或者在功能特性对应的 PR 上提出咨询。 或者在功能特性对应的 PR 上提出咨询。
如果继续工作是没有问题的,你可以使用 如果继续工作是没有问题的,你可以使用
[向他人的 PR 中提交](/zh/docs/contribute/review/for-approvers/#commit-into-another-persons-pr) [向他人的 PR 中提交](/zh-cn/docs/contribute/review/for-approvers/#commit-into-another-persons-pr)
中描述的技术之一,参与 PR 的编辑工作。 中描述的技术之一,参与 PR 的编辑工作。
<!-- <!--
@@ -257,11 +257,11 @@ table with Alpha and Beta history intact.
--> -->
如果你在处理的功能特性处于 Alpha 或 Beta 阶段并由某特性门控控制, 如果你在处理的功能特性处于 Alpha 或 Beta 阶段并由某特性门控控制,
请确保在你的 PR 中,该特性门控被添加到 请确保在你的 PR 中,该特性门控被添加到
[Alpha/Beta 特性门控](/zh/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-alpha-or-beta-features) [Alpha/Beta 特性门控](/zh-cn/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-alpha-or-beta-features)
表格中。对于新的特性门控选项,需要为该特性门控提供一段描述。 表格中。对于新的特性门控选项,需要为该特性门控提供一段描述。
如果所处理的功能特性已经进入正式发布(GA)状态或者被废弃, 如果所处理的功能特性已经进入正式发布(GA)状态或者被废弃,
请确保将其从上述表格中迁移到 请确保将其从上述表格中迁移到
[已毕业或废弃的特性](/zh/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-graduated-or-deprecated-features) [已毕业或废弃的特性](/zh-cn/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-graduated-or-deprecated-features)
表格中,并确保迁移后保留其 Alpha、Beta 版本变迁历史。 表格中,并确保迁移后保留其 Alpha、Beta 版本变迁历史。
<!-- <!--
@@ -27,11 +27,11 @@ To contribute new content pages or improve existing content pages, open a pull r
--> -->
{{< note >}} {{< note >}}
**代码开发者们**:如果你在为下一个 Kubernetes 发行版本中的某功能特性撰写文档, **代码开发者们**:如果你在为下一个 Kubernetes 发行版本中的某功能特性撰写文档,
请参考[为发行版本撰写功能特性文档](/zh/docs/contribute/new-content/new-features/)。 请参考[为发行版本撰写功能特性文档](/zh-cn/docs/contribute/new-content/new-features/)。
{{< /note >}} {{< /note >}}
要贡献新的内容页面或者改进已有内容页面,请发起拉取请求(PR)。 要贡献新的内容页面或者改进已有内容页面,请发起拉取请求(PR)。
请确保你满足了[开始之前](/zh/docs/contribute/new-content/#before-you-begin)一节中所列举的所有要求。 请确保你满足了[开始之前](/zh-cn/docs/contribute/new-content/#before-you-begin)一节中所列举的所有要求。
<!-- <!--
If your change is small, or you're unfamiliar with git, read [Changes using If your change is small, or you're unfamiliar with git, read [Changes using
@@ -348,9 +348,9 @@ class changes,changes2 white
- 针对已有内容的改进,请使用 `upstream/main` - 针对已有内容的改进,请使用 `upstream/main`
- 针对已有功能特性的新文档内容,请使用 `upstream/main` - 针对已有功能特性的新文档内容,请使用 `upstream/main`
- 对于本地化内容,请基于本地化的约定。 - 对于本地化内容,请基于本地化的约定。
可参考[本地化 Kubernetes 文档](/zh/docs/contribute/localization/)了解详细信息。 可参考[本地化 Kubernetes 文档](/zh-cn/docs/contribute/localization/)了解详细信息。
- 对于在下一个 Kubernetes 版本中新功能特性的文档,使用独立的功能特性分支。 - 对于在下一个 Kubernetes 版本中新功能特性的文档,使用独立的功能特性分支。
参考[为发行版本撰写功能特性文档](/zh/docs/contribute/new-content/new-features/)了解更多信息。 参考[为发行版本撰写功能特性文档](/zh-cn/docs/contribute/new-content/new-features/)了解更多信息。
- 对于很多 SIG Docs 共同参与的,需较长时间才完成的任务,例如内容的重构, - 对于很多 SIG Docs 共同参与的,需较长时间才完成的任务,例如内容的重构,
请使用为该任务创建的特性分支。 请使用为该任务创建的特性分支。
@@ -493,7 +493,7 @@ You can either build the website's container image or run Hugo locally. Building
通过预览你可以发现构建错误或者 Markdown 格式问题。 通过预览你可以发现构建错误或者 Markdown 格式问题。
你可以构建网站的容器镜像或者在本地运行 Hugo。 你可以构建网站的容器镜像或者在本地运行 Hugo。
构建容器镜像的方式比较慢,不过能够显示 [Hugo 短代码(shortcodes](/zh/docs/contribute/style/hugo-shortcodes/) 构建容器镜像的方式比较慢,不过能够显示 [Hugo 短代码(shortcodes](/zh-cn/docs/contribute/style/hugo-shortcodes/)
因此对于调试是很有用的。 因此对于调试是很有用的。
{{< tabs name="tab_with_hugo" >}} {{< tabs name="tab_with_hugo" >}}
@@ -685,7 +685,7 @@ GitHub also automatically assigns labels to a PR, to help reviewers. You can add
GitHub 也会自动为 PR 分派一些标签,以帮助评阅人。 GitHub 也会自动为 PR 分派一些标签,以帮助评阅人。
如果有需要,你也可以向 PR 添加标签。 如果有需要,你也可以向 PR 添加标签。
欲了解相关详细信息,可以参考 欲了解相关详细信息,可以参考
[添加和删除 Issue 标签](/zh/docs/contribute/review/for-approvers/#adding-and-removing-issue-labels)。 [添加和删除 Issue 标签](/zh-cn/docs/contribute/review/for-approvers/#adding-and-removing-issue-labels)。
<!-- <!--
### Addressing feedback locally ### Addressing feedback locally
@@ -1020,5 +1020,5 @@ the templates with as much detail as possible when you file issues or PRs.
<!-- <!--
- Read [Reviewing](/docs/contribute/reviewing/revewing-prs) to learn more about the review process. - Read [Reviewing](/docs/contribute/reviewing/revewing-prs) to learn more about the review process.
--> -->
- 阅读[评阅](/zh/docs/contribute/review/reviewing-prs)节,学习评阅过程。 - 阅读[评阅](/zh-cn/docs/contribute/review/reviewing-prs)节,学习评阅过程。
@@ -15,11 +15,11 @@ SIG Docs [approvers](/docs/contribute/participate/roles-and-responsibilities/#ap
This section covers the duties of a PR wrangler. For more information on giving good reviews, see [Reviewing changes](/docs/contribute/review/). This section covers the duties of a PR wrangler. For more information on giving good reviews, see [Reviewing changes](/docs/contribute/review/).
--> -->
SIG Docs 的[批准人(Approvers](/zh/docs/contribute/participate/roles-and-responsibilities/#approvers)们每周轮流负责 SIG Docs 的[批准人(Approvers](/zh-cn/docs/contribute/participate/roles-and-responsibilities/#approvers)们每周轮流负责
[管理仓库的 PR](https://github.com/kubernetes/website/wiki/PR-Wranglers)。 [管理仓库的 PR](https://github.com/kubernetes/website/wiki/PR-Wranglers)。
本节介绍 PR 管理者的职责。关于如何提供较好的评审意见, 本节介绍 PR 管理者的职责。关于如何提供较好的评审意见,
可参阅[评审变更](/zh/docs/contribute/review/)。 可参阅[评审变更](/zh-cn/docs/contribute/review/)。
<!-- body --> <!-- body -->
@@ -36,11 +36,11 @@ Each day in a week-long shift as PR Wrangler:
在为期一周的轮值期内,PR 管理者要: 在为期一周的轮值期内,PR 管理者要:
- 每天对新增的 Issues 判定和打标签。参见 - 每天对新增的 Issues 判定和打标签。参见
[对 Issues 进行判定和分类](/zh/docs/contribute/review/for-approvers/#triage-and-categorize-issues) [对 Issues 进行判定和分类](/zh-cn/docs/contribute/review/for-approvers/#triage-and-categorize-issues)
以了解 SIG Docs 如何使用元数据的详细信息。 以了解 SIG Docs 如何使用元数据的详细信息。
- 检查[悬决的 PR](https://github.com/kubernetes/website/pulls) 的质量并确保它们符合 - 检查[悬决的 PR](https://github.com/kubernetes/website/pulls) 的质量并确保它们符合
[样式指南](/zh/docs/contribute/style/style-guide/)和 [样式指南](/zh-cn/docs/contribute/style/style-guide/)和
[内容指南](/zh/docs/contribute/style/content-guide/)要求。 [内容指南](/zh-cn/docs/contribute/style/content-guide/)要求。
- 首先查看最小的 PR`size/XS`),然后逐渐扩展到最大的 - 首先查看最小的 PR`size/XS`),然后逐渐扩展到最大的
PR`size/XXL`),尽可能多地评审 PR。 PR`size/XXL`),尽可能多地评审 PR。
@@ -77,7 +77,7 @@ Each day in a week-long shift as PR Wrangler:
- 使用 `/approve` 评论来批准可以合并的 PR,在 PR 就绪时将其合并。 - 使用 `/approve` 评论来批准可以合并的 PR,在 PR 就绪时将其合并。
- PR 在被合并之前,应该有来自其他成员的 `/lgtm` 评论。 - PR 在被合并之前,应该有来自其他成员的 `/lgtm` 评论。
- 可以考虑接受那些技术上准确,但文风上不满足 - 可以考虑接受那些技术上准确,但文风上不满足
[风格指南](/zh/docs/contribute/style/style-guide/)要求的 PR。 [风格指南](/zh-cn/docs/contribute/style/style-guide/)要求的 PR。
批准变更时,可以登记一个新的 Issue 来解决文档风格问题。 批准变更时,可以登记一个新的 Issue 来解决文档风格问题。
你通常可以将这些风格修复问题标记为 `good first issue` 你通常可以将这些风格修复问题标记为 `good first issue`
- 将风格修复事项标记为 `good first issue` 可以很好地确保向新加入的贡献者分派一些比较简单的任务, - 将风格修复事项标记为 `good first issue` 可以很好地确保向新加入的贡献者分派一些比较简单的任务,
@@ -27,8 +27,8 @@ In addition to the rotation, a bot assigns reviewers and approvers
for the PR based on the owners for the affected files. for the PR based on the owners for the affected files.
--> -->
SIG Docs SIG Docs
[评阅人(Reviewers](/zh/docs/contribute/participate/roles-and-responsibilities/#reviewers) [评阅人(Reviewers](/zh-cn/docs/contribute/participate/roles-and-responsibilities/#reviewers)
和[批准人(Approvers](/zh/docs/contribute/participate/roles-and-responsibilities/#approvers) 和[批准人(Approvers](/zh-cn/docs/contribute/participate/roles-and-responsibilities/#approvers)
在对变更进行评审时需要做一些额外的事情。 在对变更进行评审时需要做一些额外的事情。
每周都有一个特定的文档批准人自愿负责对 PR 进行分类和评阅。 每周都有一个特定的文档批准人自愿负责对 PR 进行分类和评阅。
@@ -51,7 +51,7 @@ Everything described in [Reviewing a pull request](/docs/contribute/review/revie
Kubernetes 文档遵循 [Kubernetes 代码评阅流程](https://github.com/kubernetes/community/blob/master/contributors/guide/owners.md#the-code-review-process)。 Kubernetes 文档遵循 [Kubernetes 代码评阅流程](https://github.com/kubernetes/community/blob/master/contributors/guide/owners.md#the-code-review-process)。
[评阅 PR](/zh/docs/contribute/review/reviewing-prs/) 文档中所描述的所有规程都适用, [评阅 PR](/zh-cn/docs/contribute/review/reviewing-prs/) 文档中所描述的所有规程都适用,
不过评阅人和批准人还要做以下工作: 不过评阅人和批准人还要做以下工作:
<!-- <!--
@@ -74,7 +74,7 @@ when it comes to requesting technical review from code contributors.
你可以查看 Markdown 文件的文件头,其中的 `reviewers` 字段给出了哪些人可以为文档提供技术审核。 你可以查看 Markdown 文件的文件头,其中的 `reviewers` 字段给出了哪些人可以为文档提供技术审核。
{{< /note >}} {{< /note >}}
- 确保 PR 遵从[内容指南](/zh/docs/contribute/style/content-guide/)和[样式指南](/zh/docs/contribute/style/style-guide/) - 确保 PR 遵从[内容指南](/zh-cn/docs/contribute/style/content-guide/)和[样式指南](/zh-cn/docs/contribute/style/style-guide/)
如果 PR 没有达到要求,指引作者阅读指南中的相关部分。 如果 PR 没有达到要求,指引作者阅读指南中的相关部分。
- 适当的时候使用 GitHub **Request Changes** 选项,建议 PR 作者实施所建议的修改。 - 适当的时候使用 GitHub **Request Changes** 选项,建议 PR 作者实施所建议的修改。
- 当你所提供的建议被采纳后,在 GitHub 中使用 `/approve``/lgtm` Prow 命令,改变评审状态。 - 当你所提供的建议被采纳后,在 GitHub 中使用 `/approve``/lgtm` Prow 命令,改变评审状态。
@@ -30,7 +30,7 @@ docs, follow the [style guide](/docs/contribute/style/style-guide).
你可以在 https://slack.k8s.io 注册到 Kubernetes Slack。 你可以在 https://slack.k8s.io 注册到 Kubernetes Slack。
关于为 Kubernetes 文档创建新内容的更多信息,可参考 关于为 Kubernetes 文档创建新内容的更多信息,可参考
[样式指南](/zh/docs/contribute/style/style-guide)。 [样式指南](/zh-cn/docs/contribute/style/style-guide)。
<!-- body --> <!-- body -->
@@ -92,9 +92,9 @@ Kubernetes 文档包含 Kubernetes 项目下的多个项目的应用示例。
Kubernetes 需要某些第三方内容才能正常工作。例如 Kubernetes 需要某些第三方内容才能正常工作。例如
容器运行时(containerd、CRI-O、Docker), 容器运行时(containerd、CRI-O、Docker),
[联网策略](/zh/docs/concepts/extend-kubernetes/compute-storage-net/network-plugins/) [联网策略](/zh-cn/docs/concepts/extend-kubernetes/compute-storage-net/network-plugins/)
CNI 插件),[Ingress 控制器](/zh/docs/concepts/services-networking/ingress-controllers/) CNI 插件),[Ingress 控制器](/zh-cn/docs/concepts/services-networking/ingress-controllers/)
以及[日志](/zh/docs/concepts/cluster-administration/logging/)等。 以及[日志](/zh-cn/docs/concepts/cluster-administration/logging/)等。
只有对应的第三方开源软件(OSS)是运行 Kubernetes 所必需的,才可以在文档中包含 只有对应的第三方开源软件(OSS)是运行 Kubernetes 所必需的,才可以在文档中包含
指向这些 Kubernetes 项目之外的软件的链接。 指向这些 Kubernetes 项目之外的软件的链接。
@@ -138,4 +138,4 @@ If you have questions about allowed content, join the [Kubernetes Slack](https:/
## {{% heading "whatsnext" %}} ## {{% heading "whatsnext" %}}
* 阅读[样式指南](/zh/docs/contribute/style/style-guide)。 * 阅读[样式指南](/zh-cn/docs/contribute/style/style-guide)。
@@ -159,7 +159,7 @@ One example is [Custom Hugo Shortcodes](/docs/contribute/style/hugo-shortcodes/)
除了独立的内容页面(Markdown 文件),Hugo 还支持 除了独立的内容页面(Markdown 文件),Hugo 还支持
[页面包](https://gohugo.io/content-management/page-bundles/)。 [页面包](https://gohugo.io/content-management/page-bundles/)。
一个例子是[定制的 Hugo 短代码(shortcodes](/zh/docs/contribute/style/hugo-shortcodes/)。 一个例子是[定制的 Hugo 短代码(shortcodes](/zh-cn/docs/contribute/style/hugo-shortcodes/)。
它被认为是 `leaf bundle`(叶子包)。 它被认为是 `leaf bundle`(叶子包)。
目录下的所有内容,包括 `index.md`,都是包的一部分。此外还包括页面间相对链接、可被处理的图像等: 目录下的所有内容,包括 `index.md`,都是包的一部分。此外还包括页面间相对链接、可被处理的图像等:
@@ -222,7 +222,7 @@ The `SASS` source of the stylesheets for this site is stored below `src/sass` an
* Learn about the [Content guide](/docs/contribute/style/content-guide) * Learn about the [Content guide](/docs/contribute/style/content-guide)
--> -->
* 了解[定制 Hugo 短代码](/zh/docs/contribute/style/hugo-shortcodes/) * 了解[定制 Hugo 短代码](/zh-cn/docs/contribute/style/hugo-shortcodes/)
* 了解[样式指南](/zh/docs/contribute/style/style-guide) * 了解[样式指南](/zh-cn/docs/contribute/style/style-guide)
* 了解[内容指南](/zh/docs/contribute/style/content-guide) * 了解[内容指南](/zh-cn/docs/contribute/style/content-guide)
@@ -85,10 +85,10 @@ All you need to begin working with Mermaid is the following:
* 对 Markdown 有一个基本的了解 * 对 Markdown 有一个基本的了解
* 使用 Mermaid 在线编辑器 * 使用 Mermaid 在线编辑器
* 使用 [Hugo 短代码(shortcode](/zh/docs/contribute/style/hugo-shortcodes/) * 使用 [Hugo 短代码(shortcode](/zh-cn/docs/contribute/style/hugo-shortcodes/)
* 使用 [Hugo {{</* figure */>}} 短代码](https://gohugo.io/content-management/shortcodes/#figure) * 使用 [Hugo {{</* figure */>}} 短代码](https://gohugo.io/content-management/shortcodes/#figure)
* 执行 [Hugo 本地预览](/zh/docs/contribute/new-content/open-a-pr/#preview-locally) * 执行 [Hugo 本地预览](/zh-cn/docs/contribute/new-content/open-a-pr/#preview-locally)
* 熟悉[贡献新内容](/zh/docs/contribute/new-content/)的流程 * 熟悉[贡献新内容](/zh-cn/docs/contribute/new-content/)的流程
{{< note >}} {{< note >}}
<!-- <!--
@@ -416,7 +416,7 @@ The following lists advantages of the Inline method:
You should use the [local](/docs/contribute/new-content/open-a-pr/#preview-locally) You should use the [local](/docs/contribute/new-content/open-a-pr/#preview-locally)
and Netlify previews to verify the diagram is properly rendered. and Netlify previews to verify the diagram is properly rendered.
--> -->
你应该使用[本地](/zh/docs/contribute/new-content/open-a-pr/#preview-locally)和 Netlify 你应该使用[本地](/zh-cn/docs/contribute/new-content/open-a-pr/#preview-locally)和 Netlify
预览来验证图表是可以正常渲染的。 预览来验证图表是可以正常渲染的。
{{< caution >}} {{< caution >}}
@@ -564,7 +564,7 @@ Be sure to check that your diagram renders properly using the
[local](/docs/contribute/new-content/open-a-pr/#preview-locally) [local](/docs/contribute/new-content/open-a-pr/#preview-locally)
and Netlify previews. and Netlify previews.
--> -->
要使用[本地](/zh/docs/contribute/new-content/open-a-pr/#preview-locally)和 要使用[本地](/zh-cn/docs/contribute/new-content/open-a-pr/#preview-locally)和
Netlify 预览来检查你的图表可以正常渲染。 Netlify 预览来检查你的图表可以正常渲染。
<!-- <!--
@@ -670,7 +670,7 @@ If your external drawing tool permits:
* 你可以将多个 `.svg``.png` 商标、图标或图片整合到你的图表中。 * 你可以将多个 `.svg``.png` 商标、图标或图片整合到你的图表中。
不过,你需要确保你查看了版权并遵守了 Kubernetes 文档关于使用第三方内容的 不过,你需要确保你查看了版权并遵守了 Kubernetes 文档关于使用第三方内容的
[指南](/zh/docs/contribute/style/content-guide/)。 [指南](/zh-cn/docs/contribute/style/content-guide/)。
* 你应该将图表的源位置保存起来,以便其他贡献者访问。 * 你应该将图表的源位置保存起来,以便其他贡献者访问。
例如,你的工具可能提供指向图表文件的链接,或者你应该将源代码文件 例如,你的工具可能提供指向图表文件的链接,或者你应该将源代码文件
(例如一个 `.xml` 文件)放到某处以便其他贡献者访问。 (例如一个 `.xml` 文件)放到某处以便其他贡献者访问。
@@ -695,7 +695,7 @@ Don't forget to check that your diagram renders correctly using the
* 贡献者对外部工具更为熟悉 * 贡献者对外部工具更为熟悉
* 图表可能需要 Mermaid 所无法提供的细节 * 图表可能需要 Mermaid 所无法提供的细节
不要忘记使用[本地](/zh/docs/contribute/new-content/open-a-pr/#preview-locally) 不要忘记使用[本地](/zh-cn/docs/contribute/new-content/open-a-pr/#preview-locally)
和 Netlify 预览来检查你的图表可以正常渲染。 和 Netlify 预览来检查你的图表可以正常渲染。
<!-- <!--
@@ -728,7 +728,7 @@ page.
--> -->
### 示例 1 - Pod 拓扑分布约束 ### 示例 1 - Pod 拓扑分布约束
图 6 展示的是 [Pod 拓扑分布约束](/zh/docs/concepts/workloads/pods/pod-topology-spread-constraints/#node-labels) 图 6 展示的是 [Pod 拓扑分布约束](/zh-cn/docs/concepts/workloads/pods/pod-topology-spread-constraints/#node-labels)
页面所出现的图表。 页面所出现的图表。
{{< mermaid >}} {{< mermaid >}}
@@ -792,7 +792,7 @@ Figure 7 shows the diagram appearing in the [What is Ingress](/docs/concepts/ser
--> -->
### 示例 2 - Ingress ### 示例 2 - Ingress
图 7 显示的是 [Ingress 是什么](/zh/docs/concepts/services-networking/ingress/#what-is-ingress) 图 7 显示的是 [Ingress 是什么](/zh-cn/docs/concepts/services-networking/ingress/#what-is-ingress)
页面所出现的图表。 页面所出现的图表。
{{< mermaid >}} {{< mermaid >}}
@@ -860,7 +860,7 @@ K8s components to start a container.
图 8 给出的是一个 Mermaid 时序图,展示启动容器时 K8s 组件间的控制流。 图 8 给出的是一个 Mermaid 时序图,展示启动容器时 K8s 组件间的控制流。
{{< figure src="/zh/docs/images/diagram-guide-example-3.svg" alt="K8s system flow diagram" class="diagram-large" caption="Figure 8. K8s system flow diagram" link="https://mermaid-js.github.io/mermaid-live-editor/edit/#eyJjb2RlIjoiJSV7aW5pdDp7XCJ0aGVtZVwiOlwibmV1dHJhbFwifX0lJVxuc2VxdWVuY2VEaWFncmFtXG4gICAgYWN0b3IgbWVcbiAgICBwYXJ0aWNpcGFudCBhcGlTcnYgYXMgY29udHJvbCBwbGFuZTxicj48YnI-YXBpLXNlcnZlclxuICAgIHBhcnRpY2lwYW50IGV0Y2QgYXMgY29udHJvbCBwbGFuZTxicj48YnI-ZXRjZCBkYXRhc3RvcmVcbiAgICBwYXJ0aWNpcGFudCBjbnRybE1nciBhcyBjb250cm9sIHBsYW5lPGJyPjxicj5jb250cm9sbGVyPGJyPm1hbmFnZXJcbiAgICBwYXJ0aWNpcGFudCBzY2hlZCBhcyBjb250cm9sIHBsYW5lPGJyPjxicj5zY2hlZHVsZXJcbiAgICBwYXJ0aWNpcGFudCBrdWJlbGV0IGFzIG5vZGU8YnI-PGJyPmt1YmVsZXRcbiAgICBwYXJ0aWNpcGFudCBjb250YWluZXIgYXMgbm9kZTxicj48YnI-Y29udGFpbmVyPGJyPnJ1bnRpbWVcbiAgICBtZS0-PmFwaVNydjogMS4ga3ViZWN0bCBjcmVhdGUgLWYgcG9kLnlhbWxcbiAgICBhcGlTcnYtLT4-ZXRjZDogMi4gc2F2ZSBuZXcgc3RhdGVcbiAgICBjbnRybE1nci0-PmFwaVNydjogMy4gY2hlY2sgZm9yIGNoYW5nZXNcbiAgICBzY2hlZC0-PmFwaVNydjogNC4gd2F0Y2ggZm9yIHVuYXNzaWduZWQgcG9kcyhzKVxuICAgIGFwaVNydi0-PnNjaGVkOiA1LiBub3RpZnkgYWJvdXQgcG9kIHcgbm9kZW5hbWU9XCIgXCJcbiAgICBzY2hlZC0-PmFwaVNydjogNi4gYXNzaWduIHBvZCB0byBub2RlXG4gICAgYXBpU3J2LS0-PmV0Y2Q6IDcuIHNhdmUgbmV3IHN0YXRlXG4gICAga3ViZWxldC0-PmFwaVNydjogOC4gbG9vayBmb3IgbmV3bHkgYXNzaWduZWQgcG9kKHMpXG4gICAgYXBpU3J2LT4-a3ViZWxldDogOS4gYmluZCBwb2QgdG8gbm9kZVxuICAgIGt1YmVsZXQtPj5jb250YWluZXI6IDEwLiBzdGFydCBjb250YWluZXJcbiAgICBrdWJlbGV0LT4-YXBpU3J2OiAxMS4gdXBkYXRlIHBvZCBzdGF0dXNcbiAgICBhcGlTcnYtLT4-ZXRjZDogMTIuIHNhdmUgbmV3IHN0YXRlIiwibWVybWFpZCI6IntcbiAgXCJ0aGVtZVwiOiBcImRlZmF1bHRcIlxufSIsInVwZGF0ZUVkaXRvciI6ZmFsc2UsImF1dG9TeW5jIjp0cnVlLCJ1cGRhdGVEaWFncmFtIjp0cnVlfQ" >}} {{< figure src="/zh-cn/docs/images/diagram-guide-example-3.svg" alt="K8s system flow diagram" class="diagram-large" caption="Figure 8. K8s system flow diagram" link="https://mermaid-js.github.io/mermaid-live-editor/edit/#eyJjb2RlIjoiJSV7aW5pdDp7XCJ0aGVtZVwiOlwibmV1dHJhbFwifX0lJVxuc2VxdWVuY2VEaWFncmFtXG4gICAgYWN0b3IgbWVcbiAgICBwYXJ0aWNpcGFudCBhcGlTcnYgYXMgY29udHJvbCBwbGFuZTxicj48YnI-YXBpLXNlcnZlclxuICAgIHBhcnRpY2lwYW50IGV0Y2QgYXMgY29udHJvbCBwbGFuZTxicj48YnI-ZXRjZCBkYXRhc3RvcmVcbiAgICBwYXJ0aWNpcGFudCBjbnRybE1nciBhcyBjb250cm9sIHBsYW5lPGJyPjxicj5jb250cm9sbGVyPGJyPm1hbmFnZXJcbiAgICBwYXJ0aWNpcGFudCBzY2hlZCBhcyBjb250cm9sIHBsYW5lPGJyPjxicj5zY2hlZHVsZXJcbiAgICBwYXJ0aWNpcGFudCBrdWJlbGV0IGFzIG5vZGU8YnI-PGJyPmt1YmVsZXRcbiAgICBwYXJ0aWNpcGFudCBjb250YWluZXIgYXMgbm9kZTxicj48YnI-Y29udGFpbmVyPGJyPnJ1bnRpbWVcbiAgICBtZS0-PmFwaVNydjogMS4ga3ViZWN0bCBjcmVhdGUgLWYgcG9kLnlhbWxcbiAgICBhcGlTcnYtLT4-ZXRjZDogMi4gc2F2ZSBuZXcgc3RhdGVcbiAgICBjbnRybE1nci0-PmFwaVNydjogMy4gY2hlY2sgZm9yIGNoYW5nZXNcbiAgICBzY2hlZC0-PmFwaVNydjogNC4gd2F0Y2ggZm9yIHVuYXNzaWduZWQgcG9kcyhzKVxuICAgIGFwaVNydi0-PnNjaGVkOiA1LiBub3RpZnkgYWJvdXQgcG9kIHcgbm9kZW5hbWU9XCIgXCJcbiAgICBzY2hlZC0-PmFwaVNydjogNi4gYXNzaWduIHBvZCB0byBub2RlXG4gICAgYXBpU3J2LS0-PmV0Y2Q6IDcuIHNhdmUgbmV3IHN0YXRlXG4gICAga3ViZWxldC0-PmFwaVNydjogOC4gbG9vayBmb3IgbmV3bHkgYXNzaWduZWQgcG9kKHMpXG4gICAgYXBpU3J2LT4-a3ViZWxldDogOS4gYmluZCBwb2QgdG8gbm9kZVxuICAgIGt1YmVsZXQtPj5jb250YWluZXI6IDEwLiBzdGFydCBjb250YWluZXJcbiAgICBrdWJlbGV0LT4-YXBpU3J2OiAxMS4gdXBkYXRlIHBvZCBzdGF0dXNcbiAgICBhcGlTcnYtLT4-ZXRjZDogMTIuIHNhdmUgbmV3IHN0YXRlIiwibWVybWFpZCI6IntcbiAgXCJ0aGVtZVwiOiBcImRlZmF1bHRcIlxufSIsInVwZGF0ZUVkaXRvciI6ZmFsc2UsImF1dG9TeW5jIjp0cnVlLCJ1cGRhdGVEaWFncmFtIjp0cnVlfQ" >}}
<!-- <!--
@@ -101,7 +101,7 @@ page content.
有两种词汇表提示:`glossary_tooltip``glossary_definition` 有两种词汇表提示:`glossary_tooltip``glossary_definition`
你可以通过加入术语词汇的短代码,来自动更新和替换相应链接中的内容 你可以通过加入术语词汇的短代码,来自动更新和替换相应链接中的内容
[我们的词汇库](/zh/docs/reference/glossary/) [我们的词汇库](/zh-cn/docs/reference/glossary/)
在浏览在线文档时,术语会显示为超链接的样式,当鼠标移到术语上时,其解释就会显示在提示框中。 在浏览在线文档时,术语会显示为超链接的样式,当鼠标移到术语上时,其解释就会显示在提示框中。
除了包含工具提示外,你还可以重用页面内容中词汇表中的定义。 除了包含工具提示外,你还可以重用页面内容中词汇表中的定义。
@@ -457,7 +457,7 @@ usually need to add a
to your cluster so that name resolution works. to your cluster so that name resolution works.
--> -->
运行 Kubernetes 需要第三方软件。例如:你通常需要将 运行 Kubernetes 需要第三方软件。例如:你通常需要将
[DNS 服务器](/zh/docs/tasks/administer-cluster/dns-custom-nameservers/#introduction) [DNS 服务器](/zh-cn/docs/tasks/administer-cluster/dns-custom-nameservers/#introduction)
添加到集群中,以便名称解析工作。 添加到集群中,以便名称解析工作。
<!-- <!--
@@ -465,7 +465,7 @@ When we link to third-party software, or otherwise mention it,
we follow the [content guide](/docs/contribute/style/content-guide/) we follow the [content guide](/docs/contribute/style/content-guide/)
and we also mark those third party items. and we also mark those third party items.
--> -->
当我们链接到第三方软件或以其他方式提及它时,我们会遵循[内容指南](/zh/docs/contribute/style/content-guide/) 当我们链接到第三方软件或以其他方式提及它时,我们会遵循[内容指南](/zh-cn/docs/contribute/style/content-guide/)
并标记这些第三方项目。 并标记这些第三方项目。
<!-- <!--
@@ -645,7 +645,7 @@ Renders to:
--> -->
* 了解 [Hugo](https://gohugo.io/)。 * 了解 [Hugo](https://gohugo.io/)。
* 了解[撰写新的话题](/zh/docs/contribute/style/write-new-topic/)。 * 了解[撰写新的话题](/zh-cn/docs/contribute/style/write-new-topic/)。
* 了解[使用页面内容类型](/zh/docs/contribute/style/page-content-types/)。 * 了解[使用页面内容类型](/zh-cn/docs/contribute/style/page-content-types/)。
* 了解[发起 PR](/zh/docs/contribute/new-content/open-a-pr/)。 * 了解[发起 PR](/zh-cn/docs/contribute/new-content/open-a-pr/)。
* 了解[进阶贡献](/zh/docs/contribute/advanced/)。 * 了解[进阶贡献](/zh-cn/docs/contribute/advanced/)。
@@ -198,7 +198,7 @@ published example of a concept page.
- 在 `body` 节中,详细解释对应概念; - 在 `body` 节中,详细解释对应概念;
- 对于 `whatsnext` 节,提供一个项目符号列表(最多 5 个),帮助读者进一步学习掌握概念 - 对于 `whatsnext` 节,提供一个项目符号列表(最多 5 个),帮助读者进一步学习掌握概念
[注解](/zh/docs/concepts/overview/working-with-objects/annotations/)页面是一个已经 [注解](/zh-cn/docs/concepts/overview/working-with-objects/annotations/)页面是一个已经
上线的概念页面的例子。 上线的概念页面的例子。
<!-- <!--
@@ -271,7 +271,7 @@ An example of a published task topic is [Using an HTTP proxy to access the Kuber
- 在 `whatsnext` 节中,使用项目符号列表(不超过 5 项),列举读者可能接下来有兴趣 - 在 `whatsnext` 节中,使用项目符号列表(不超过 5 项),列举读者可能接下来有兴趣
阅读的主题。 阅读的主题。
已上线的任务主题示例之一是[使用 HTTP 代理来访问 Kubernetes API](/zh/docs/tasks/extend-kubernetes/http-proxy-access-api/)。 已上线的任务主题示例之一是[使用 HTTP 代理来访问 Kubernetes API](/zh-cn/docs/tasks/extend-kubernetes/http-proxy-access-api/)。
<!-- <!--
### Tutorial ### Tutorial
@@ -354,7 +354,7 @@ An example of a published tutorial topic is
阅读的主题。 阅读的主题。
已发布的教程主题的一个例子是 已发布的教程主题的一个例子是
[使用 Deployment 运行无状态应用](/zh/docs/tasks/run-application/run-stateless-application-deployment/). [使用 Deployment 运行无状态应用](/zh-cn/docs/tasks/run-application/run-stateless-application-deployment/).
<!-- <!--
### Reference ### Reference
@@ -395,9 +395,9 @@ Examples of published tool reference pages are:
已发布的工具参考页面示例包括: 已发布的工具参考页面示例包括:
- [kubeadm init](/zh/docs/reference/setup-tools/kubeadm/kubeadm-init/) - [kubeadm init](/zh-cn/docs/reference/setup-tools/kubeadm/kubeadm-init/)
- [kube-apiserver](/zh/docs/reference/command-line-tools-reference/kube-apiserver/) - [kube-apiserver](/zh-cn/docs/reference/command-line-tools-reference/kube-apiserver/)
- [kubectl](/zh/docs/reference/kubectl/kubectl/) - [kubectl](/zh-cn/docs/reference/kubectl/kubectl/)
## {{% heading "whatsnext" %}} ## {{% heading "whatsnext" %}}
@@ -406,7 +406,7 @@ Examples of published tool reference pages are:
- Learn about the [Content guide](/docs/contribute/style/content-guide/) - Learn about the [Content guide](/docs/contribute/style/content-guide/)
- Learn about [content organization](/docs/contribute/style/content-organization/) - Learn about [content organization](/docs/contribute/style/content-organization/)
--> -->
- 了解[样式指南](/zh/docs/contribute/style/style-guide/) - 了解[样式指南](/zh-cn/docs/contribute/style/style-guide/)
- 了解[内容指南](/zh/docs/contribute/style/content-guide/) - 了解[内容指南](/zh-cn/docs/contribute/style/content-guide/)
- 了解[内容组织](/zh/docs/contribute/style/content-organization/) - 了解[内容组织](/zh-cn/docs/contribute/style/content-organization/)
@@ -459,8 +459,8 @@ To specify the Kubernetes version for a task or tutorial page, include `min-kube
代码示例或者配置示例如果包含版本信息,应该与对应的文字描述一致。 代码示例或者配置示例如果包含版本信息,应该与对应的文字描述一致。
如果所给的信息是特定于具体版本的,需要在 如果所给的信息是特定于具体版本的,需要在
[任务模版](/zh/docs/contribute/style/page-content-types/#task) [任务模版](/zh-cn/docs/contribute/style/page-content-types/#task)
或[教程模版](/zh/docs/contribute/style/page-content-types/#tutorial) 或[教程模版](/zh-cn/docs/contribute/style/page-content-types/#tutorial)
`prerequisites` 小节定义 Kubernetes 版本。 `prerequisites` 小节定义 Kubernetes 版本。
页面保存之后,`prerequisites` 小节会显示为 **开始之前** 页面保存之后,`prerequisites` 小节会显示为 **开始之前**
@@ -952,7 +952,7 @@ Write Markdown-style links: `[link text](URL)`. For example: `[Hugo shortcodes](
可以 | 不可以 可以 | 不可以
:--| :----- :--| :-----
插入超级链接时给出它们所链接到的目标内容的上下文。例如:你的机器上某些端口处于开放状态。参见<a href="#check-required-ports">检查所需端口</a>了解更详细信息。| 使用有二义性的术语,如“点击这里”。例如:你的机器上某些端口处于打开状态。参见<a href="#check-required-ports">这里</a>了解详细信息。 插入超级链接时给出它们所链接到的目标内容的上下文。例如:你的机器上某些端口处于开放状态。参见<a href="#check-required-ports">检查所需端口</a>了解更详细信息。| 使用有二义性的术语,如“点击这里”。例如:你的机器上某些端口处于打开状态。参见<a href="#check-required-ports">这里</a>了解详细信息。
编写 Markdown 风格的链接:`[链接文本](URL)`。例如:`[Hugo 短代码](/zh/docs/contribute/style/hugo-shortcodes/#table-captions)`,输出是[Hugo 短代码](/zh/docs/contribute/style/hugo-shortcodes/#table-captions). | 编写 HTML 风格的超级链接:`<a href="/media/examples/link-element-example.css" target="_blank">访问我们的教程!</a>`,或者创建会打开新 Tab 页或新窗口的链接。例如:`[网站示例](https://example.com){target="_blank"}` 编写 Markdown 风格的链接:`[链接文本](URL)`。例如:`[Hugo 短代码](/zh-cn/docs/contribute/style/hugo-shortcodes/#table-captions)`,输出是[Hugo 短代码](/zh-cn/docs/contribute/style/hugo-shortcodes/#table-captions). | 编写 HTML 风格的超级链接:`<a href="/media/examples/link-element-example.css" target="_blank">访问我们的教程!</a>`,或者创建会打开新 Tab 页或新窗口的链接。例如:`[网站示例](https://example.com){target="_blank"}`
{{< /table >}} {{< /table >}}
<!-- <!--
@@ -1015,7 +1015,7 @@ The semantic purpose of a data table is to present tabular data. Sighted users c
表格标题可以用来给数据表提供一个描述性的标题。 表格标题可以用来给数据表提供一个描述性的标题。
辅助技术使用 HTML 表格标题元素来在页面结构中辨识表格内容。 辅助技术使用 HTML 表格标题元素来在页面结构中辨识表格内容。
- 请 [Hugo 短代码](/zh/docs/contribute/style/hugo-shortcodes/#table-captions) - 请 [Hugo 短代码](/zh-cn/docs/contribute/style/hugo-shortcodes/#table-captions)
为表格添加标题。 为表格添加标题。
<!-- <!--
@@ -21,7 +21,7 @@ This page shows how to create a new topic for the Kubernetes docs.
Create a fork of the Kubernetes documentation repository as described in Create a fork of the Kubernetes documentation repository as described in
[Start contributing](/docs/contribute/start/). [Start contributing](/docs/contribute/start/).
--> -->
如[发起 PR](/zh/docs/contribute/new-content/open-a-pr/)中所述,创建 Kubernetes 文档库的派生副本。 如[发起 PR](/zh-cn/docs/contribute/new-content/open-a-pr/)中所述,创建 Kubernetes 文档库的派生副本。
<!-- steps --> <!-- steps -->
@@ -46,8 +46,8 @@ Tutorial | A tutorial page shows how to accomplish a goal that ties together sev
{{< table caption = "选择页面类型的说明" >}} {{< table caption = "选择页面类型的说明" >}}
类型 | 描述 类型 | 描述
:--- | :---------- :--- | :----------
概念(Concept | 概念页面负责解释 Kubernetes 的某方面。例如,概念页面可以描述 Kubernetes Deployment 对象,并解释当部署、扩展和更新时,它作为应用程序所扮演的角色。一般来说,概念页面不包括步骤序列,而是提供任务或教程的链接。概念主题的示例可参见 <a href="/zh/docs/concepts/architecture/nodes/">节点</a>。 概念(Concept | 概念页面负责解释 Kubernetes 的某方面。例如,概念页面可以描述 Kubernetes Deployment 对象,并解释当部署、扩展和更新时,它作为应用程序所扮演的角色。一般来说,概念页面不包括步骤序列,而是提供任务或教程的链接。概念主题的示例可参见 <a href="/zh-cn/docs/concepts/architecture/nodes/">节点</a>。
任务(Task) | 任务页面展示如何完成特定任务。其目的是给读者提供一系列的步骤,让他们在阅读时可以实际执行。任务页面可长可短,前提是它始终围绕着某个主题展开。在任务页面中,可以将简短的解释与要执行的步骤混合在一起。如果需要提供较长的解释,则应在概念主题中进行。相关联的任务和概念主题应该相互链接。一个简短的任务页面的实例可参见 <a href="/zh/docs/tasks/configure-pod-container/configure-volume-storage/">配置 Pod 使用卷存储</a>。一个较长的任务页面的实例可参见 <a href="/zh/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/">配置活跃性和就绪性探针</a>。 任务(Task) | 任务页面展示如何完成特定任务。其目的是给读者提供一系列的步骤,让他们在阅读时可以实际执行。任务页面可长可短,前提是它始终围绕着某个主题展开。在任务页面中,可以将简短的解释与要执行的步骤混合在一起。如果需要提供较长的解释,则应在概念主题中进行。相关联的任务和概念主题应该相互链接。一个简短的任务页面的实例可参见 <a href="/zh-cn/docs/tasks/configure-pod-container/configure-volume-storage/">配置 Pod 使用卷存储</a>。一个较长的任务页面的实例可参见 <a href="/zh-cn/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/">配置活跃性和就绪性探针</a>。
教程(Tutorial) | 教程页面展示如何实现某个目标,该目标将若干 Kubernetes 功能特性联系在一起。教程可能提供一些步骤序列,读者可以在阅读页面时实际执行这些步骤。或者它可以提供相关代码片段的解释。例如,教程可以提供代码示例的讲解。教程可以包括对 Kubernetes 几个关联特性的简要解释,但有关更深入的特性解释应该链接到相关概念主题。 教程(Tutorial) | 教程页面展示如何实现某个目标,该目标将若干 Kubernetes 功能特性联系在一起。教程可能提供一些步骤序列,读者可以在阅读页面时实际执行这些步骤。或者它可以提供相关代码片段的解释。例如,教程可以提供代码示例的讲解。教程可以包括对 Kubernetes 几个关联特性的简要解释,但有关更深入的特性解释应该链接到相关概念主题。
{{< /table >}} {{< /table >}}
@@ -56,7 +56,7 @@ Use a [content type](/docs/contribute/style/page-content-types/) for each new pa
that you write. Using page type helps ensure that you write. Using page type helps ensure
consistency among topics of a given type. consistency among topics of a given type.
--> -->
为每个新页面选择其[内容类型](/zh/docs/contribute/style/page-content-types/)。 为每个新页面选择其[内容类型](/zh-cn/docs/contribute/style/page-content-types/)。
使用页面类型有助于确保给定类型的各主题之间保持一致。 使用页面类型有助于确保给定类型的各主题之间保持一致。
<!-- <!--
@@ -74,7 +74,7 @@ URL for the topic, for example:
选择一个标题,确保其中包含希望搜索引擎发现的关键字。 选择一个标题,确保其中包含希望搜索引擎发现的关键字。
确定文件名时请使用标题中的单词,由连字符分隔。 确定文件名时请使用标题中的单词,由连字符分隔。
例如,标题为[Using an HTTP Proxy to Access Kubernetes API](/zh/docs/tasks/extend-kubernetes/http-proxy-access-api/) 例如,标题为[Using an HTTP Proxy to Access Kubernetes API](/zh-cn/docs/tasks/extend-kubernetes/http-proxy-access-api/)
的主题的文件名为 `http-proxy-access-api.md` 的主题的文件名为 `http-proxy-access-api.md`
你不需要在文件名中加上 "kubernetes",因为 "kubernetes" 已经在主题的 URL 中了, 你不需要在文件名中加上 "kubernetes",因为 "kubernetes" 已经在主题的 URL 中了,
例如: 例如:
@@ -189,10 +189,10 @@ following cases (not an exhaustive list):
- 代码显示来自命令的输出,例如 `kubectl get deploy mydeployment -o json | jq '.status'` - 代码显示来自命令的输出,例如 `kubectl get deploy mydeployment -o json | jq '.status'`
- 代码不够通用,用户无法验证。例如,你可以嵌入 YAML 文件来创建一个依赖于特定 - 代码不够通用,用户无法验证。例如,你可以嵌入 YAML 文件来创建一个依赖于特定
[FlexVolume](/zh/docs/concepts/storage/volumes#flexvolume) 实现的 Pod。 [FlexVolume](/zh-cn/docs/concepts/storage/volumes#flexvolume) 实现的 Pod。
- 该代码是一个不完整的示例,因为其目的是突出展现某个大文件中的部分内容。 - 该代码是一个不完整的示例,因为其目的是突出展现某个大文件中的部分内容。
例如,在描述出于某些原因定制 例如,在描述出于某些原因定制
[PodSecurityPolicy](/zh/docs/tasks/administer-cluster/sysctl-cluster/#podsecuritypolicy) [PodSecurityPolicy](/zh-cn/docs/tasks/administer-cluster/sysctl-cluster/#podsecuritypolicy)
的方法时,你可以在主题文件中直接提供一个短的代码段。 的方法时,你可以在主题文件中直接提供一个短的代码段。
- 由于某些其他原因,该代码不适合用户验证。 - 由于某些其他原因,该代码不适合用户验证。
例如,当使用 `kubectl edit` 命令描述如何将新属性添加到资源时, 例如,当使用 `kubectl edit` 命令描述如何将新属性添加到资源时,
@@ -285,7 +285,7 @@ For an example of a topic that uses this technique, see
[Running a Single-Instance Stateful Application](/docs/tutorials/stateful-application/run-stateful-application/). [Running a Single-Instance Stateful Application](/docs/tutorials/stateful-application/run-stateful-application/).
--> -->
有关使用此技术的主题的示例,请参见 有关使用此技术的主题的示例,请参见
[运行单实例有状态的应用](/zh/docs/tasks/run-application/run-single-instance-stateful-application/)。 [运行单实例有状态的应用](/zh-cn/docs/tasks/run-application/run-single-instance-stateful-application/)。
<!-- <!--
## Adding images to a topic ## Adding images to a topic
@@ -302,6 +302,6 @@ Put image files in the `/images` directory. The preferred image format is SVG.
* Learn about [using page content types](/docs/contribute/style/page-content-types/). * Learn about [using page content types](/docs/contribute/style/page-content-types/).
* Learn about [creating a pull request](/docs/contribute/new-content/open-a-pr/). * Learn about [creating a pull request](/docs/contribute/new-content/open-a-pr/).
--> -->
* 了解[使用页面内容类型](/zh/docs/contribute/style/page-content-types/). * 了解[使用页面内容类型](/zh-cn/docs/contribute/style/page-content-types/).
* 了解[创建 PR](/zh/docs/contribute/new-content/open-a-pr/). * 了解[创建 PR](/zh-cn/docs/contribute/new-content/open-a-pr/).