whentimeslows/website
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #28915 from chenxuc/new-zh-rule

Browse Source 
[zh]Add a new rule and fix format
This commit is contained in:
Kubernetes Prow Robot
2021-07-14 01:18:27 -07:00
committed by GitHub
parent 2c02aeb43a 875b67c219
commit 757298d1d6
1 changed files with 23 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files
content/zh/docs/contribute/localization_zh.md
+23 -23
View File
@@ -6,8 +6,7 @@ content_type: concept
<!-- overview --> <!-- overview -->
本节详述文档中文本地化过程中须注意的事项。 本节详述文档中文本地化过程中须注意的事项。
这里列举的内容包含了*中文本地化小组*早期给出的指导性建议和后续实践过程中 这里列举的内容包含了*中文本地化小组*早期给出的指导性建议和后续实践过程中积累的经验。
积累的经验。
在阅读、贡献、评阅中文本地化文档的过程中，如果对本文的指南有任何改进建议， 在阅读、贡献、评阅中文本地化文档的过程中，如果对本文的指南有任何改进建议，
都请直接提出 PR。我们欢迎任何形式的补充和更正！ 都请直接提出 PR。我们欢迎任何形式的补充和更正！
@@ -167,8 +166,8 @@ English text
{{</* /note */>}} {{</* /note */>}}
``` ```
评阅人应该不难理解中英文段落的对应关系。但是如果采用下面的方式，则会出现 评阅人应该不难理解中英文段落的对应关系。但是如果采用下面的方式，
两个 `note`，因此需要避免。这是因为被注释起来的短代码仍会起作用！ 则会出现两个 `note`，因此需要避免。这是因为被注释起来的短代码仍会起作用！
``` ```
<!-- <!--
@@ -193,14 +192,14 @@ deployment 来表示名为 "Deployment" 的 API 资源类型和对象实例。
{{< note >}} {{< note >}}
英文原文在这方面并不严谨，译者或中文译文的评阅者要非常留心。 英文原文在这方面并不严谨，译者或中文译文的评阅者要非常留心。
比如 Secret 资源，很多时候被误写为 secret。这时在本地化版本中一定 比如 Secret 资源，很多时候被误写为 secret。
不能译为“秘密”，以免与原文的语义不符。 这时在本地化版本中一定不能译为“秘密”，以免与原文的语义不符。
{{< /note >}} {{< /note >}}
#### 代码中的注释 #### 代码中的注释
一般而言，代码中的注释需要翻译，包括存放在 `content/zh/examples/` 目录下 一般而言，代码中的注释需要翻译，包括存放在 `content/zh/examples/`
的清单文件中的注释。 目录下的清单文件中的注释。
#### 出站链接 #### 出站链接
@@ -228,15 +227,15 @@ Please check [installation caveats](https://acme.com/docs/v1/caveats) ...
## 更新译文 ## 更新译文
由于整个文档站点会随着 Kubernetes 项目的开发进展而演化，英文版本的网站内容 由于整个文档站点会随着 Kubernetes 项目的开发进展而演化，英文版本的网站内容会不断更新。
会不断更新。鉴于中文站点的基本翻译工作在 1.19 版本已完成，从 1.20 版本开始 鉴于中文站点的基本翻译工作在 1.19 版本已完成，
本地化的工作会集中在追踪英文内容变化上。 从 1.20 版本开始本地化的工作会集中在追踪英文内容变化上。
为确保准确跟踪中文化版本与英文版本之间的差异，中文内容的 PR 所包含的每个页面 为确保准确跟踪中文化版本与英文版本之间的差异，中文内容的 PR 所包含的每个页面都必须是“最新的”。
都必须是“最新的”。这里的“最新”指的是对应的英文页面中的更改已全部同步到中文页面。 这里的“最新”指的是对应的英文页面中的更改已全部同步到中文页面。
如果某中文 PR 中包含对 `content/zh/docs/foo/bar.md` 的更改，且文件 `bar.md` 的 如果某中文 PR 中包含对 `content/zh/docs/foo/bar.md` 的更改，且文件 `bar.md`
上次更改日期是 `2020-10-01 01:02:03 UTC`，对应 GIT 标签 `abcd1234`，则 的上次更改日期是 `2020-10-01 01:02:03 UTC`，对应 GIT 标签 `abcd1234`，
`bar.md` 应包含自 `abcd1234` 以来 `content/en/docs/foo/bar.md` 的所有变更， 则 `bar.md` 应包含自 `abcd1234` 以来 `content/en/docs/foo/bar.md` 的所有变更，
否则视此 PR 为不完整 PR，会破坏我们对上游变更的跟踪。 否则视此 PR 为不完整 PR，会破坏我们对上游变更的跟踪。
这一要求适用于所有更改，包括拼写错误、格式更正、链接修订等等。要查看文件 这一要求适用于所有更改，包括拼写错误、格式更正、链接修订等等。要查看文件
@@ -251,8 +250,8 @@ Please check [installation caveats](https://acme.com/docs/v1/caveats) ...
### 链接锚点 ### 链接锚点
英文 Markdown 中的各级标题会自动生成锚点，以便从其他页面中链接。 英文 Markdown 中的各级标题会自动生成锚点，以便从其他页面中链接。
在译为中文后，相应的链接必然会失效。为防止这类问题，建议在翻译 在译为中文后，相应的链接必然会失效。为防止这类问题，
各级标题时，使用英文方式显式给出链接锚点。例如： 建议在翻译各级标题时，使用英文方式显式给出链接锚点。例如：
``` ```
<!-- <!--
@@ -299,14 +298,15 @@ Website 的仓库中 `scripts/linkchecker.py` 是一个工具，可用来检查
- 译文 Markdown 中不要使用长行，应适当断行。 - 译文 Markdown 中不要使用长行，应适当断行。
* 可根据需要在 80-120 列断行 * 可根据需要在 80-120 列断行
* 最好结合句子的边界断行，即一句话在一行，不必留几个字转到下一行 * 最好结合句子的边界断行，即一句话在一行，不必留几个字转到下一行
* 不要在两个中文字符中间断行，因为这样会造成中文字符中间显示一个多余空格，
如果句子太长，可以从中文与非中文符号之间断行
* 超级链接文字一般较长，可独立成行 * 超级链接文字一般较长，可独立成行
{{< warning >}} {{< warning >}}
我们注意到有些贡献者可能使用了某种自动化工具，在 Markdown 英文原文中自动 我们注意到有些贡献者可能使用了某种自动化工具，在 Markdown 英文原文中自动添加空格。
添加空格。虽然这些工具可一定程度提高效率，仍然需要提请作者注意，某些工具 虽然这些工具可一定程度提高效率，仍然需要提请作者注意，某些工具所作的转换可能是不对的，
所作的转换可能是不对的，例如将 `foo=bar` 转换为 `foo = bar`、将 例如将 `foo=bar` 转换为 `foo = bar`、将 `），另一些文字` 转换为 `） ，另一些文字` 等等，
`），另一些文字` 转换为 `） ，另一些文字` 等等，甚至将超级链接中的半角 甚至将超级链接中的半角井号（`#`）转换为全角，导致链接失效。
井号（`#`）转换为全角，导致链接失效。
{{< /warning >}} {{< /warning >}}
英文中 "you" 翻译成 "你" 不必是 “您"。 英文中 "you" 翻译成 "你" 不必是 “您"。