[zh]Update contribute pages for links with '/zh/' prefix, using new prefix '/zh-cn/'
This commit is contained in:
@@ -30,7 +30,7 @@ docs, follow the [style guide](/docs/contribute/style/style-guide).
|
||||
你可以在 https://slack.k8s.io 注册到 Kubernetes Slack。
|
||||
|
||||
关于为 Kubernetes 文档创建新内容的更多信息,可参考
|
||||
[样式指南](/zh/docs/contribute/style/style-guide)。
|
||||
[样式指南](/zh-cn/docs/contribute/style/style-guide)。
|
||||
|
||||
<!-- body -->
|
||||
|
||||
@@ -92,9 +92,9 @@ Kubernetes 文档包含 Kubernetes 项目下的多个项目的应用示例。
|
||||
|
||||
Kubernetes 需要某些第三方内容才能正常工作。例如
|
||||
容器运行时(containerd、CRI-O、Docker),
|
||||
[联网策略](/zh/docs/concepts/extend-kubernetes/compute-storage-net/network-plugins/)
|
||||
(CNI 插件),[Ingress 控制器](/zh/docs/concepts/services-networking/ingress-controllers/)
|
||||
以及[日志](/zh/docs/concepts/cluster-administration/logging/)等。
|
||||
[联网策略](/zh-cn/docs/concepts/extend-kubernetes/compute-storage-net/network-plugins/)
|
||||
(CNI 插件),[Ingress 控制器](/zh-cn/docs/concepts/services-networking/ingress-controllers/)
|
||||
以及[日志](/zh-cn/docs/concepts/cluster-administration/logging/)等。
|
||||
|
||||
只有对应的第三方开源软件(OSS)是运行 Kubernetes 所必需的,才可以在文档中包含
|
||||
指向这些 Kubernetes 项目之外的软件的链接。
|
||||
@@ -138,4 +138,4 @@ If you have questions about allowed content, join the [Kubernetes Slack](https:/
|
||||
|
||||
## {{% 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 还支持
|
||||
[页面包](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`(叶子包)。
|
||||
目录下的所有内容,包括 `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)
|
||||
-->
|
||||
|
||||
* 了解[定制 Hugo 短代码](/zh/docs/contribute/style/hugo-shortcodes/)
|
||||
* 了解[样式指南](/zh/docs/contribute/style/style-guide)
|
||||
* 了解[内容指南](/zh/docs/contribute/style/content-guide)
|
||||
* 了解[定制 Hugo 短代码](/zh-cn/docs/contribute/style/hugo-shortcodes/)
|
||||
* 了解[样式指南](/zh-cn/docs/contribute/style/style-guide)
|
||||
* 了解[内容指南](/zh-cn/docs/contribute/style/content-guide)
|
||||
|
||||
|
||||
@@ -85,10 +85,10 @@ All you need to begin working with Mermaid is the following:
|
||||
|
||||
* 对 Markdown 有一个基本的了解
|
||||
* 使用 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 本地预览](/zh/docs/contribute/new-content/open-a-pr/#preview-locally)
|
||||
* 熟悉[贡献新内容](/zh/docs/contribute/new-content/)的流程
|
||||
* 执行 [Hugo 本地预览](/zh-cn/docs/contribute/new-content/open-a-pr/#preview-locally)
|
||||
* 熟悉[贡献新内容](/zh-cn/docs/contribute/new-content/)的流程
|
||||
|
||||
{{< 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)
|
||||
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 >}}
|
||||
@@ -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)
|
||||
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 预览来检查你的图表可以正常渲染。
|
||||
|
||||
<!--
|
||||
@@ -670,7 +670,7 @@ If your external drawing tool permits:
|
||||
|
||||
* 你可以将多个 `.svg` 或 `.png` 商标、图标或图片整合到你的图表中。
|
||||
不过,你需要确保你查看了版权并遵守了 Kubernetes 文档关于使用第三方内容的
|
||||
[指南](/zh/docs/contribute/style/content-guide/)。
|
||||
[指南](/zh-cn/docs/contribute/style/content-guide/)。
|
||||
* 你应该将图表的源位置保存起来,以便其他贡献者访问。
|
||||
例如,你的工具可能提供指向图表文件的链接,或者你应该将源代码文件
|
||||
(例如一个 `.xml` 文件)放到某处以便其他贡献者访问。
|
||||
@@ -695,7 +695,7 @@ Don't forget to check that your diagram renders correctly using the
|
||||
* 贡献者对外部工具更为熟悉
|
||||
* 图表可能需要 Mermaid 所无法提供的细节
|
||||
|
||||
不要忘记使用[本地](/zh/docs/contribute/new-content/open-a-pr/#preview-locally)
|
||||
不要忘记使用[本地](/zh-cn/docs/contribute/new-content/open-a-pr/#preview-locally)
|
||||
和 Netlify 预览来检查你的图表可以正常渲染。
|
||||
|
||||
<!--
|
||||
@@ -728,7 +728,7 @@ page.
|
||||
-->
|
||||
### 示例 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 >}}
|
||||
@@ -792,7 +792,7 @@ Figure 7 shows the diagram appearing in the [What is Ingress](/docs/concepts/ser
|
||||
-->
|
||||
### 示例 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 >}}
|
||||
@@ -860,7 +860,7 @@ K8s components to start a container.
|
||||
|
||||
图 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`。
|
||||
|
||||
你可以通过加入术语词汇的短代码,来自动更新和替换相应链接中的内容
|
||||
([我们的词汇库](/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.
|
||||
-->
|
||||
运行 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/)
|
||||
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/)。
|
||||
* 了解[撰写新的话题](/zh/docs/contribute/style/write-new-topic/)。
|
||||
* 了解[使用页面内容类型](/zh/docs/contribute/style/page-content-types/)。
|
||||
* 了解[发起 PR](/zh/docs/contribute/new-content/open-a-pr/)。
|
||||
* 了解[进阶贡献](/zh/docs/contribute/advanced/)。
|
||||
* 了解[撰写新的话题](/zh-cn/docs/contribute/style/write-new-topic/)。
|
||||
* 了解[使用页面内容类型](/zh-cn/docs/contribute/style/page-content-types/)。
|
||||
* 了解[发起 PR](/zh-cn/docs/contribute/new-content/open-a-pr/)。
|
||||
* 了解[进阶贡献](/zh-cn/docs/contribute/advanced/)。
|
||||
|
||||
@@ -198,7 +198,7 @@ published example of a concept page.
|
||||
- 在 `body` 节中,详细解释对应概念;
|
||||
- 对于 `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 项),列举读者可能接下来有兴趣
|
||||
阅读的主题。
|
||||
|
||||
已上线的任务主题示例之一是[使用 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
|
||||
@@ -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
|
||||
@@ -395,9 +395,9 @@ Examples of published tool reference pages are:
|
||||
|
||||
已发布的工具参考页面示例包括:
|
||||
|
||||
- [kubeadm init](/zh/docs/reference/setup-tools/kubeadm/kubeadm-init/)
|
||||
- [kube-apiserver](/zh/docs/reference/command-line-tools-reference/kube-apiserver/)
|
||||
- [kubectl](/zh/docs/reference/kubectl/kubectl/)
|
||||
- [kubeadm init](/zh-cn/docs/reference/setup-tools/kubeadm/kubeadm-init/)
|
||||
- [kube-apiserver](/zh-cn/docs/reference/command-line-tools-reference/kube-apiserver/)
|
||||
- [kubectl](/zh-cn/docs/reference/kubectl/kubectl/)
|
||||
|
||||
## {{% 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 [content organization](/docs/contribute/style/content-organization/)
|
||||
-->
|
||||
- 了解[样式指南](/zh/docs/contribute/style/style-guide/)
|
||||
- 了解[内容指南](/zh/docs/contribute/style/content-guide/)
|
||||
- 了解[内容组织](/zh/docs/contribute/style/content-organization/)
|
||||
- 了解[样式指南](/zh-cn/docs/contribute/style/style-guide/)
|
||||
- 了解[内容指南](/zh-cn/docs/contribute/style/content-guide/)
|
||||
- 了解[内容组织](/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/docs/contribute/style/page-content-types/#tutorial)
|
||||
[任务模版](/zh-cn/docs/contribute/style/page-content-types/#task)
|
||||
或[教程模版](/zh-cn/docs/contribute/style/page-content-types/#tutorial)
|
||||
的 `prerequisites` 小节定义 Kubernetes 版本。
|
||||
页面保存之后,`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>了解详细信息。
|
||||
编写 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 >}}
|
||||
|
||||
<!--
|
||||
@@ -1015,7 +1015,7 @@ The semantic purpose of a data table is to present tabular data. Sighted users c
|
||||
表格标题可以用来给数据表提供一个描述性的标题。
|
||||
辅助技术使用 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
|
||||
[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 -->
|
||||
|
||||
@@ -46,8 +46,8 @@ Tutorial | A tutorial page shows how to accomplish a goal that ties together sev
|
||||
{{< table caption = "选择页面类型的说明" >}}
|
||||
类型 | 描述
|
||||
:--- | :----------
|
||||
概念(Concept) | 概念页面负责解释 Kubernetes 的某方面。例如,概念页面可以描述 Kubernetes Deployment 对象,并解释当部署、扩展和更新时,它作为应用程序所扮演的角色。一般来说,概念页面不包括步骤序列,而是提供任务或教程的链接。概念主题的示例可参见 <a href="/zh/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>。
|
||||
概念(Concept) | 概念页面负责解释 Kubernetes 的某方面。例如,概念页面可以描述 Kubernetes Deployment 对象,并解释当部署、扩展和更新时,它作为应用程序所扮演的角色。一般来说,概念页面不包括步骤序列,而是提供任务或教程的链接。概念主题的示例可参见 <a href="/zh-cn/docs/concepts/architecture/nodes/">节点</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 几个关联特性的简要解释,但有关更深入的特性解释应该链接到相关概念主题。
|
||||
{{< /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
|
||||
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`。
|
||||
你不需要在文件名中加上 "kubernetes",因为 "kubernetes" 已经在主题的 URL 中了,
|
||||
例如:
|
||||
@@ -189,10 +189,10 @@ following cases (not an exhaustive list):
|
||||
|
||||
- 代码显示来自命令的输出,例如 `kubectl get deploy mydeployment -o json | jq '.status'`。
|
||||
- 代码不够通用,用户无法验证。例如,你可以嵌入 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` 命令描述如何将新属性添加到资源时,
|
||||
@@ -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/).
|
||||
-->
|
||||
有关使用此技术的主题的示例,请参见
|
||||
[运行单实例有状态的应用](/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
|
||||
@@ -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 [creating a pull request](/docs/contribute/new-content/open-a-pr/).
|
||||
-->
|
||||
* 了解[使用页面内容类型](/zh/docs/contribute/style/page-content-types/).
|
||||
* 了解[创建 PR](/zh/docs/contribute/new-content/open-a-pr/).
|
||||
* 了解[使用页面内容类型](/zh-cn/docs/contribute/style/page-content-types/).
|
||||
* 了解[创建 PR](/zh-cn/docs/contribute/new-content/open-a-pr/).
|
||||
|
||||
|
||||
Reference in New Issue
Block a user