add zh pages

This commit is contained in:
Karen Bradshaw
2020-06-01 09:23:39 -04:00
parent 21fd0a12f9
commit 4b35d4d401
303 changed files with 2764 additions and 2439 deletions
+6 -6
View File
@@ -1,5 +1,5 @@
---
content_template: templates/concept
content_type: concept
title: 为 Kubernetes 文档做贡献
linktitle: 贡献
main_menu: true
@@ -8,7 +8,7 @@ weight: 80
<!--
---
content_template: templates/concept
content_type: concept
title: Contribute to Kubernetes docs
linktitle: Contribute
main_menu: true
@@ -16,7 +16,7 @@ weight: 80
---
-->
{{% capture overview %}}
<!-- overview -->
<!--
If you would like to help contribute to the Kubernetes documentation or website,
@@ -42,9 +42,9 @@ Looking for the [style guide](/docs/contribute/style/style-guide/) or the
查找 [样式指南](/docs/contribute/style/style-guide/) 或者 [Kubernetes 社区网站](/community/)
{{% /capture %}}
{{% capture body %}}
<!-- body -->
<!--
## Types of contributor
@@ -188,4 +188,4 @@ documentation, but it should help you get started.
- 如果您要开发新的特性,请阅读 [contributor cheatsheet](https://github.com/kubernetes/community/tree/master/contributors/guide/contributor-cheatsheet).
{{% /capture %}}
+6 -6
View File
@@ -1,19 +1,19 @@
---
title: 高级贡献
slug: advanced
content_template: templates/concept
content_type: concept
weight: 30
---
<!--
---
title: Advanced contributing
slug: advanced
content_template: templates/concept
content_type: concept
weight: 30
---
-->
{{% capture overview %}}
<!-- overview -->
<!--
This page assumes that you've read and mastered the
@@ -24,9 +24,9 @@ client and other tools for some of these tasks.
-->
如果你已经阅读并掌握[开始贡献](/docs/contribute/start/)和[中级贡献](/docs/contribute/intermediate/),并准备了解更多贡献的途径,请阅读此文。您需要使用 Git 命令行工具和其他工具做这些工作。
{{% /capture %}}
{{% capture body %}}
<!-- body -->
<!--
## Be the PR Wrangler for a week
@@ -470,4 +470,4 @@ The video uploads automatically to YouTube.
视频会自动上传到 YouTube。
{{% /capture %}}
@@ -1,15 +1,15 @@
---
title: 为上游 Kubernetes 代码库做出贡献
content_template: templates/task
content_type: task
---
<!--
---
title: Contributing to the Upstream Kubernetes Code
content_template: templates/task
content_type: task
---
-->
{{% capture overview %}}
<!-- overview -->
<!--
This page shows how to contribute to the upstream kubernetes/kubernetes project
@@ -31,10 +31,11 @@ API or the `kube-*` components from the upstream code, see the following instruc
- [生成 Kubernetes API 的参考文档](/docs/contribute/generate-ref-docs/kubernetes-api/)
- [生成 Kubernetes 组件和工具的参考文档](/docs/contribute/generate-ref-docs/kubernetes-components/)
{{% /capture %}}
{{% capture prerequisites %}}
## {{% heading "prerequisites" %}}
<!--
You need to have these tools installed:
@@ -70,10 +71,10 @@ information, see
[GitHub 标准 Fork 和 PR 工作流程](https://gist.github.com/Chaser324/ce0505fbed06b947d962)。
{{% /capture %}}
{{% capture steps %}}
<!-- steps -->
<!--
## The big picture
@@ -388,9 +389,10 @@ You are now ready to follow the [Generating Reference Documentation for the Kube
现在,您可以按照[生成 Kubernetes API 的参考文档](/docs/contribute/generate-ref-docs/kubernetes-api/)指南来生成
[已发布的 Kubernetes API 参考文档](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/)。
{{% /capture %}}
{{% capture whatsnext %}}
## {{% heading "whatsnext" %}}
<!--
* [Generating Reference Documentation for the Kubernetes API](/docs/contribute/generate-ref-docs/kubernetes-api/)
@@ -401,5 +403,5 @@ You are now ready to follow the [Generating Reference Documentation for the Kube
* [为 Kubernetes 组件和工具生成参考文档](/docs/home/contribute/generated-reference/kubernetes-components/)
* [生成 kubectl 命令的参考文档](/docs/home/contribute/generated-reference/kubectl/)
{{% /capture %}}
@@ -1,16 +1,16 @@
---
title: 为 kubectl 命令集生成参考文档
content_template: templates/task
content_type: task
---
<!--
---
title: Generating Reference Documentation for kubectl Commands
content_template: templates/task
content_type: task
---
-->
{{% capture overview %}}
<!-- overview -->
<!--
This page shows how to automatically generate reference pages for the
@@ -38,10 +38,11 @@ reference page, see
本主题没有展示如何生成 [kubectl](/docs/reference/generated/kubectl/kubectl/) 组件的参考页面。相关说明请参见[为 Kubernetes 组件和工具生成参考页面](/docs/home/contribute/generated-reference/kubernetes-components/)。
{{< /note >}}
{{% /capture %}}
{{% capture prerequisites %}}
## {{% heading "prerequisites" %}}
<!--
* You need to have
@@ -76,10 +77,10 @@ information, see
* 你需要知道如何在一个 GitHub 项目仓库中创建一个 PR。一般来说,这涉及到创建仓库的一个分支。想了解更多信息,请参见[创建一个文档 PR](/docs/home/contribute/create-pull-request/) 和 [GitHub 标准 Fork & PR 工作流](https://gist.github.com/Chaser324/ce0505fbed06b947d962)。
{{% /capture %}}
{{% capture steps %}}
<!-- steps -->
<!--
## Setting up the local repositories
@@ -470,9 +471,10 @@ topics will be visible in the
在 PR 合入的几分钟后,你更新的参考主题将出现在[已发布文档](/docs/home/)中。
{{% /capture %}}
{{% capture whatsnext %}}
## {{% heading "whatsnext" %}}
<!--
* [Generating Reference Documentation for Kubernetes Components and Tools](/docs/home/contribute/generated-reference/kubernetes-components/)
@@ -484,4 +486,3 @@ topics will be visible in the
* [为 Kubernetes API 生成参考文档](/docs/home/contribute/generated-reference/kubernetes-api/)
* [为 Kubernetes 联邦 API 生成参考文档](/docs/home/contribute/generated-reference/federation-api/)
{{% /capture %}}
@@ -1,15 +1,15 @@
---
title: 为 Kubernetes API 生成参考文档
content_template: templates/task
content_type: task
---
<!--
---
title: Generating Reference Documentation for the Kubernetes API
content_template: templates/task
content_type: task
---
-->
{{% capture overview %}}
<!-- overview -->
<!--
This page shows how to update the generated reference docs for the Kubernetes API.
@@ -30,10 +30,11 @@ Kubernetes API 参考文档是从 [Kubernetes OpenAPI 规范](https://github.com
如果您只需要从 [OpenAPI](https://github.com/OAI/OpenAPI-Specification) 规范中重新生成参考文档,请继续阅读此页面。
{{% /capture %}}
{{% capture prerequisites %}}
## {{% heading "prerequisites" %}}
<!--
You need to have these tools installed:
@@ -58,10 +59,10 @@ information, see
-->
你需要知道如何在一个 GitHub 项目仓库中创建一个 PR。一般来说,这涉及到创建仓库的 fork 分支。想了解更多信息,请参见[创建一个文档 PR](/docs/contribute/start/) 和 [GitHub 标准 Fork & PR 工作流](https://gist.github.com/Chaser324/ce0505fbed06b947d962)。
{{% /capture %}}
{{% capture steps %}}
<!-- steps -->
<!--
## Setting up the local repositories
@@ -348,9 +349,10 @@ to monitor your pull request until it has been merged.
-->
将您的更改[创建 PR](/docs/contribute/start/) 提交到 [kubernetes/website](https://github.com/kubernetes/website) 仓库。监视您提交的 PR,并根据需要回复 reviewer 的评论。继续监视您的 PR,直到合并为止。
{{% /capture %}}
{{% capture whatsnext %}}
## {{% heading "whatsnext" %}}
<!--
* [Generating Reference Docs for Kubernetes Components and Tools](/docs/home/contribute/generated-reference/kubernetes-components/)
@@ -361,4 +363,3 @@ to monitor your pull request until it has been merged.
* [为 kubectl 命令集生成参考文档](/docs/home/contribute/generated-reference/kubectl/)
* [为 Kubernetes 联邦 API 生成参考文档](/docs/home/contribute/generated-reference/federation-api/)
{{% /capture %}}
@@ -1,16 +1,16 @@
---
title: 为 Kubernetes 组件和工具生成参考页面
content_template: templates/task
content_type: task
---
<!--
---
title: Generating Reference Pages for Kubernetes Components and Tools
content_template: templates/task
content_type: task
---
-->
{{% capture overview %}}
<!-- overview -->
<!--
This page shows how to use the `update-imported-docs` tool to generate
@@ -21,9 +21,10 @@ reference documentation for tools and components in the
本页面展示了如何使用 `update-imported-docs` 工具来为 [Kubernetes](https://github.com/kubernetes/kubernetes) 和 [Federation](https://github.com/kubernetes/federation) 仓库中的工具和组件生成参考文档。
{{% /capture %}}
{{% capture prerequisites %}}
## {{% heading "prerequisites" %}}
<!--
* You need a machine that is running Linux or macOS.
@@ -68,9 +69,9 @@ information, see
* 你需要知道如何在一个 GitHub 项目仓库中创建一个 PR。一般来说,这涉及到创建仓库的一个分支。想了解更多信息,请参见[创建一个文档 PR](/docs/home/contribute/create-pull-request/)。
{{% /capture %}}
{{% capture steps %}}
<!-- steps -->
<!--
## Getting two repositories
@@ -395,9 +396,10 @@ topics will be visible in the
在 PR 合入的几分钟后,你更新的参考主题将出现在[已发布文档](/docs/home/)中。
{{% /capture %}}
{{% capture whatsnext %}}
## {{% heading "whatsnext" %}}
<!--
* [Generating Reference Documentation for kubectl Commands](/docs/home/contribute/generated-reference/kubectl/)
@@ -409,4 +411,3 @@ topics will be visible in the
* [为 Kubernetes API 生成参考文档](/docs/home/contribute/generated-reference/kubernetes-api/)
* [为 Kubernetes 联邦 API 生成参考文档](/docs/home/contribute/generated-reference/federation-api/)
{{% /capture %}}
+9 -8
View File
@@ -1,7 +1,7 @@
---
title: 中级贡献
slug: intermediate
content_template: templates/concept
content_type: concept
weight: 20
card:
name: contribute
@@ -11,7 +11,7 @@ card:
---
title: Intermediate contributing
slug: intermediate
content_template: templates/concept
content_type: concept
weight: 20
card:
name: contribute
@@ -19,7 +19,7 @@ card:
---
-->
{{% capture overview %}}
<!-- overview -->
<!--
This page assumes that you've read and mastered the tasks in the
@@ -36,9 +36,9 @@ Some tasks require you to use the Git command line client and other tools.
有些任务需要使用 Git 命令行客户端和其他工具。
{{< /note >}}
{{% /capture %}}
{{% capture body %}}
<!-- body -->
<!--
Now that you've gotten your feet wet and helped out with the Kubernetes docs in
@@ -1436,9 +1436,10 @@ Follow these guidelines for working with localized content:
如果 PR 包含对一种以上源语言的更改,请 PR 贡献者为每种语言打开单独的 PR。
{{% /capture %}}
{{% capture whatsnext %}}
## {{% heading "whatsnext" %}}
<!--
When you are comfortable with all of the tasks discussed in this topic and you
@@ -1447,4 +1448,4 @@ want to engage with the Kubernetes docs team in even deeper ways, read the
-->
如果您熟悉本主题中讨论的所有任务,并且想与 Kubernetes 文档小组进行更深入的接触,
请阅读[文档高级贡献者](/docs/contribute/advanced/)主题。
{{% /capture %}}
+9 -8
View File
@@ -1,6 +1,6 @@
---
title: 本地化 Kubernetes 文档
content_template: templates/concept
content_type: concept
card:
name: contribute
weight: 30
@@ -9,7 +9,7 @@ card:
<!--
---
title: Localizing Kubernetes Documentation
content_template: templates/concept
content_type: concept
approvers:
- remyleone
- rlenferink
@@ -21,16 +21,16 @@ card:
---
-->
{{% capture overview %}}
<!-- overview -->
<!--
This page shows you how to [localize](https://blog.mozilla.org/l10n/2011/12/14/i18n-vs-l10n-whats-the-diff/) the docs for a different language.
-->
此页面显示了如何为其他语言的文档提供[本地化](https://blog.mozilla.org/l10n/2011/12/14/i18n-vs-l10n-whats-the-diff/)。
{{% /capture %}}
{{% capture body %}}
<!-- body -->
<!--
## Getting started
@@ -540,9 +540,10 @@ You can also help add or improve content to an existing localization. Join the [
-->
您还可以向现有本地化添加或改进内容提供帮助。加入 [Slack 频道](https://kubernetes.slack.com/messages/C1J0BPD2M/)进行本地化,然后开始新建 PR 来提供帮助。
{{% /capture %}}
{{% capture whatsnext %}}
## {{% heading "whatsnext" %}}
<!--
Once a localization meets requirements for workflow and minimum output, SIG docs will:
@@ -556,4 +557,4 @@ Once a localization meets requirements for workflow and minimum output, SIG docs
- 在网站上启用语言选择
- 通过[Cloud Native Computing Foundation](https://www.cncf.io/about/) (CNCF) 频道, 包括[ Kubernetes 博客](https://kubernetes.io/blog/)公开本地化的可用性。
{{% /capture %}}
+8 -7
View File
@@ -1,12 +1,12 @@
---
title: 参与 SIG Docs
content_template: templates/concept
content_type: concept
card:
name: contribute
weight: 40
---
{{% capture overview %}}
<!-- overview -->
<!--
SIG Docs is one of the
@@ -42,9 +42,9 @@ aspects of Kubernetes -- the Kubernetes website and documentation.
有关 Kubernetes 社区中的成员如何工作的更多信息,请参见 [community-membership](https://github.com/kubernetes/community/blob/master/community-membership.md)。
本文档的其余部分概述了这些角色在 SIG Docs 中发挥作用的一些独特方式,
SIG Docs 负责维护 Kubernetes 最面向公众的方面之一 —— Kubernetes 网站和文档。
{{% /capture %}}
{{% capture body %}}
<!-- body -->
<!--
## Roles and responsibilities
@@ -515,9 +515,10 @@ and editorial review of their PR.
-->
结合 OWNERS 文件及扉页可以给 PR 作者提供向谁请求检视的建议。
{{% /capture %}}
{{% capture whatsnext %}}
## {{% heading "whatsnext" %}}
<!--
For more information about contributing to the Kubernetes documentation, see:
@@ -527,6 +528,6 @@ For more information about contributing to the Kubernetes documentation, see:
- [Start contributing](/docs/contribute/start/)
- [Documentation style](/docs/contribute/style/)
{{% /capture %}}
+9 -8
View File
@@ -1,7 +1,7 @@
---
title: 开始贡献
slug: start
content_template: templates/concept
content_type: concept
weight: 10
card:
name: contribute
@@ -11,7 +11,7 @@ card:
---
title: Start contributing
slug: start
content_template: templates/concept
content_type: concept
weight: 10
card:
name: contribute
@@ -19,7 +19,7 @@ card:
---
-->
{{% capture overview %}}
<!-- overview -->
<!--
If you want to get started contributing to the Kubernetes documentation, this
@@ -36,10 +36,10 @@ code repositories, refer to
如果您在寻找有关如何开始向 Kubernetes 仓库贡献代码的信息,请参考 [Kubernetes 社区指南](https://github.com/kubernetes/community/blob/master/governance.md)。
{{% /capture %}}
{{% capture body %}}
<!-- body -->
<!--
## The basics about our docs
@@ -620,9 +620,10 @@ to submit your proposal.
看一下[现有案例研究](https://github.com/kubernetes/website/tree/master/content/en/case-studies)的源码。
使用 [Kubernetes 案例研究提交表](https://www.cncf.io/people/end-user-community/)提交您的提案。
{{% /capture %}}
{{% capture whatsnext %}}
## {{% heading "whatsnext" %}}
<!--
When you are comfortable with all of the tasks discussed in this topic and you
@@ -631,4 +632,4 @@ want to engage with the Kubernetes docs team in deeper ways, read the
-->
当您对本主题中讨论的所有任务感到满意,并且您希望以更深入的方式与 Kubernetes 文档团队合作,请阅读[中级贡献者指南](/docs/contribute/intermediate/)。
{{% /capture %}}
@@ -1,19 +1,19 @@
---
title: 内容组织
content_template: templates/concept
content_type: concept
weight: 40
---
<!--
---
title: Content organization
content_template: templates/concept
content_type: concept
weight: 40
---
-->
{{% capture overview %}}
<!-- overview -->
<!--
This site uses Hugo. In Hugo, [content organization](https://gohugo.io/content-management/organization/) is a core concept.
@@ -21,9 +21,9 @@ This site uses Hugo. In Hugo, [content organization](https://gohugo.io/content-m
本网站使用了 Hugo。在 Hugo 中,[内容组织](https://gohugo.io/content-management/organization/) 是一个核心概念。
{{% /capture %}}
{{% capture body %}}
<!-- body -->
{{% note %}}
<!--
@@ -255,9 +255,10 @@ The `SASS` source of the stylesheets for this site is stored below `src/sass` an
本网站的样式表的 `SASS` 源存储在 `src/sass` 下面,可以用 `make sass` 构建(Hugo很快就会得到 `SASS` 的支持,参见https://github.com/gohugoio/hugo/issues/4243)。
{{% /capture %}}
{{% capture whatsnext %}}
## {{% heading "whatsnext" %}}
<!--
* [Custom Hugo shortcodes](/docs/contribute/style/hugo-shortcodes/)
@@ -267,4 +268,4 @@ The `SASS` source of the stylesheets for this site is stored below `src/sass` an
* [定制 Hugo 短代码](/docs/contribute/style/hugo-shortcodes/)
* [样式指南](/docs/contribute/style/style-guide)
{{% /capture %}}
@@ -2,25 +2,25 @@
approvers:
- chenopis
title: 定制 Hugo 短代码
content_template: templates/concept
content_type: concept
---
<!-- ---
approvers:
- chenopis
title: Custom Hugo Shortcodes
content_template: templates/concept
content_type: concept
--- -->
{{% capture overview %}}
<!-- overview -->
<!-- This page explains the custom Hugo shortcodes that can be used in Kubernetes markdown documentation. -->
本页面将介绍定制 Hugo 短代码,可以用于 Kubernetes markdown 文档书写。
<!-- Read more about shortcodes in the [Hugo documentation](https://gohugo.io/content-management/shortcodes). -->
更多关于短代码参见 [Hugo 文档](https://gohugo.io/content-management/shortcodes)。
{{% /capture %}}
{{% capture body %}}
<!-- body -->
<!-- ## Feature state -->
## 功能状态
@@ -256,9 +256,10 @@ println "This is tab 2."
{{< /tabs >}}
{{% /capture %}}
{{% capture whatsnext %}}
## {{% heading "whatsnext" %}}
<!-- * Learn about [Hugo](https://gohugo.io/).
* Learn about [writing a new topic](/docs/home/contribute/write-new-topic/).
* Learn about [using page templates](/docs/home/contribute/page-templates/).
@@ -270,4 +271,4 @@ println "This is tab 2."
* 了解 [使用页面模板](/docs/home/contribute/page-templates/)。
* 了解 [暂存修改](/docs/home/contribute/stage-documentation-changes/)。
* 了解 [创建 pull request](/docs/home/contribute/create-pull-request/)。
{{% /capture %}}
@@ -1,18 +1,18 @@
---
title: 使用页面模板
content_template: templates/concept
content_type: concept
weight: 30
---
<!--
---
title: Using Page Templates
content_template: templates/concept
content_type: concept
weight: 30
---
-->
{{% capture overview %}}
<!-- overview -->
<!--
When contributing new topics, apply one of the following templates to them.
@@ -42,10 +42,10 @@ template to use for a new topic, start with the
{{< /note >}}
{{% /capture %}}
{{% capture body %}}
<!-- body -->
<!--
## Concept template
@@ -72,12 +72,12 @@ To write a new concept page, create a Markdown file in a subdirectory of the
要编写新的概念页面,请在 `/content/en/docs/concepts` 目录的子目录中创建一个 Markdown 文件,其特点如下:
<!--
- In the page's YAML front-matter, set `content_template: templates/concept`.
- In the page's YAML front-matter, set `content_type: concept`.
- In the page's body, set the required `capture` variables and any optional
ones you want to include:
-->
- 在页面的 YAML 头部,设置 `content_template: templates/concept`
- 在页面的 YAML 头部,设置 `content_type: concept`
- 在页面的 body 中,设置所需的 `capture` 变量和所有想要包含的变量:
| 变量 | 必需? |
@@ -153,12 +153,12 @@ To write a new task page, create a Markdown file in a subdirectory of the
要编写新的任务页面,请在 `/content/en/docs/tasks` 目录的子目录中创建一个 Markdown 文件,其特点如下:
<!--
- In the page's YAML front-matter, set `content_template: templates/task`.
- In the page's YAML front-matter, set `content_type: task`.
- In the page's body, set the required `capture` variables and any optional
ones you want to include:
-->
- 在页面的 YAML 头部,设置 `content_template: templates/task`
- 在页面的 YAML 头部,设置 `content_type: task`
- 在页面的 body 中,设置所需的 `capture` 变量和所有想要包含的变量:
| 变量 | 必需? |
@@ -253,12 +253,12 @@ To write a new tutorial page, create a Markdown file in a subdirectory of the
要编写新的教程页面,请在 `/content/en/docs/tutorials` 目录的子目录中创建一个 Markdown 文件,其特点如下:
<!--
- In the page's YAML front-matter, set `content_template: templates/tutorial`.
- In the page's YAML front-matter, set `content_type: tutorial`.
- In the page's body, set the required `capture` variables and any optional
ones you want to include:
-->
- 在页面的 YAML 头部,设置 `content_template: templates/tutorial`
- 在页面的 YAML 头部,设置 `content_type: tutorial`
- 在页面的 body 中,设置所需的 `capture` 变量和所有想要包含的变量:
| 变量 | 必需? |
@@ -337,9 +337,10 @@ An example of a published topic that uses the tutorial template is
使用教程模板的已发布主题的一个示例是[使用部署运行无状态应用程序](/docs/tutorials/stateless-application/run-stateless-application-deployment/)。
{{% /capture %}}
{{% capture whatsnext %}}
## {{% heading "whatsnext" %}}
<!--
- Learn about the [style guide](/docs/contribute/style/style-guide/)
@@ -349,4 +350,4 @@ An example of a published topic that uses the tutorial template is
- 学习[样式指南](/docs/contribute/style/style-guide/)
- 学习[内容组织](/docs/contribute/style/content-organization/)
{{% /capture %}}
@@ -1,34 +1,35 @@
---
title: 撰写新主题
content_template: templates/task
content_type: task
weight: 20
---
<!--
---
title: Writing a new topic
content_template: templates/task
content_type: task
weight: 20
---
-->
{{% capture overview %}}
<!-- overview -->
<!--
This page shows how to create a new topic for the Kubernetes docs.
-->
本页面展示如何为 Kubernetes 文档库创建新主题。
{{% /capture %}}
{{% capture prerequisites %}}
## {{% heading "prerequisites" %}}
<!--
Create a fork of the Kubernetes documentation repository as described in
[Start contributing](/docs/contribute/start/).
-->
如[开始贡献](/docs/contribute/start/)中所述,创建 Kubernetes 文档库的分支。
{{% /capture %}}
{{% capture steps %}}
<!-- steps -->
<!--
## Choosing a page type
@@ -305,15 +306,16 @@ image format is SVG.
将镜像文件放入 `/images` 目录。首选的镜像格式是 SVG。
{{% /capture %}}
<!--
* Learn about [using page templates](/docs/home/contribute/page-templates/).
* Learn about [staging your changes](/docs/home/contribute/stage-documentation-changes/).
* Learn about [creating a pull request](/docs/home/contribute/create-pull-request/).
-->
{{% capture whatsnext %}}
## {{% heading "whatsnext" %}}
* 学习[使用页面模板](/docs/home/contribute/page-templates/)。
* 学习[展示你的修改](/docs/home/contribute/stage-documentation-changes/)。
* 学习[创建一个拉取请求](/docs/home/contribute/create-pull-request/)。
{{% /capture %}}