1 / 8

云原生社区 Envoy SIG

欢迎

云原生社区 Envoy SIG

欢迎来到云原生社区 Envoy SIG（特别兴趣小组）！

加入 Envoy SIG

请填写申请表加入微信交流群。

如何提问

有关于 Envoy 的问题请提交 Issue 后将链接发到微信群中讨论。

联系

负责人

马景贺（小马哥）

Envoy 官网翻译（1.16版本）

Envoy 中文翻译流程

前提条件：

1 熟悉 GitHub 操作流程（Fork 翻译主库至个人 GItHub 账号下，clone 仓库至本地，翻译相关文件，然后 push 翻译代码至自己仓库，最后从个人仓库向 GitHub 提 PR。如果对于流程不熟悉的，可以查看此blog）。详情可查看翻译流程图示。

2 对 Envoy 所有了解

加入翻译团队

1 加入云原生社区 Envoy SIG，详细信息参考加入 Envoy SIG

2 在这儿登记自己的信息

开始翻译

翻译前请认真阅读翻译指南：

1 在 cloudnativeto/envoy 库的 issue 中认领自己想翻译的 issue，然后在comment中输入 /accept。

2 翻译完毕，提PR至 cloudnativeto/envoy 仓库，同时输入 /pushed 指令修改 issue 的状态

3 待 PR 被 merge 之后，请输入 /merged 指令关闭对应的翻译issue

4 认领下一个人任务，开始翻译

整体的翻译流程可以参考下图：

加入 Review 团队（Optional）

为了把控 Envoy 的翻译质量，我们成立了专门的 Envoy Review 团队，每一个 PR 都需要至少两位 Reviewer 通过才可以关闭，如果你想加入 Review 团队，一起把关 Envoy 翻译的质量，欢迎加入我们，可在 Envoy SIG 微信群里面，发微信给 Jimmy 或者我（小马哥）。经过面试后，我们会拉你入群。

`rst` 在线检测工具

由于 Envoy 官方文档使用 rst 格式，为了方便大家检查自己翻译文件的格式，可以使用如下工具：

Envoy 中文翻译成员及优秀人员

Envoy 翻译负责人

参与翻译人员

以在登记信息中登记的先后顺序记录了为 Envoy 翻译做出贡献的人员，会持续更新，会在最终结束时，重新以姓名重新排名，发布感谢公告。感谢大家的参与，欢迎大家持续输出。

优秀翻译及 Review 人员

在此，需要感谢厉辉(Miss-you)，宋净超(rootsongjc)两位社区管委会成员，在百忙之中对于 Envoy SIG 所做的贡献。

Envoy 翻译进度

第一阶段

第一阶段从 11 月 4 号到 12 月 28 号，共开放了 84 个 issue。

第二阶段

开始于 11 月 28 号，共开放 24 个 issue 。

第三阶段

开始于 12 月 6 号，共开放 128 个 issue。

第四阶段

开始于 2021 年 1 月 10 号，共开放 10 个 issue 。

第五阶段

开始于 2021 年 1 月 17 号，共开放 76 个 issue。

第六阶段

开始于 2021 年 2 月 9 号，共开放 34 个 issue。

Envoy 常见编译问题

本地文档编译

由于 Envoy 官网文档的特殊性，此次翻译没有用 netlify 设置翻译预览，因此需要大家在本地翻译结束后，使用如下命令来进行本地文档构建，以确定翻译文档的格式是否有问题：

cd envoy/
./ci/run_envoy_docker.sh 'docs/build.sh'

常见的编译问题大概有以下几种，可参考进行修改。

1 汉语下面的下划线长度不能小于汉语长度

正确示例如下：

Google 漏洞奖励计划（VRP）
=======================

错误示例如下：

Google 漏洞奖励计划（VRP）
==============

如用上述错误示例翻译，则在编译时候会出现如下错误：

2 超链接前后需要加空格

正确示例如下：

:ref:`威胁模型 <arch_overview_google_vrp_threat_model>` 保持一致。

请注意符号 ` 和保持两个汉字之间须加一个空格。

错误示例如下：

:ref:`威胁模型 <arch_overview_google_vrp_threat_model>`保持一致。

如按照上述错误示例翻译，会出现如下所示的错误：

3 `rst` 的链接内容可不用翻译

如下内容，只需要将 Observability 翻译为观测性即可，其他内容（如 statistics ）不用翻译，否则会编译失败。

Observability
=============

.. toctree::
  :maxdepth: 2

  statistics
  application_logging
  access_log/access_log.rst

正确翻译示例如下：

观测性
======

.. toctree::
  :maxdepth: 2

  statistics
  application_logging
  access_log/access_log.rst

错误翻译示例：

观测性
=============

.. toctree::
  :maxdepth: 2

  统计
  application_logging
  access_log/access_log.rst

多次 commit rebase 为一次进行提交

翻译过程中，难免会对同一个PR 进行多次提交，在最终的PR 里面就会出现多次提交，其中大部分提交的内容都是fix translate type 、fix translation issue 。如果合并到翻译分支，且merge 到上游仓库（有可能，这也是我们的目标），就会显得commit 信息杂乱。虽然我们review 团队在最终的merge 时候会选择squash ，但是良好的commit 习惯还是由开发人员自己养成。下面就些一个将多个commit 进行rebase ，将其变成一个节点进行提交。

第一步：查看 git log 确定要 rebase 的节点数

第二步：执行 rebase 命令

执行 git rebase -i HEAD~n ，其中n 代表想要合并的commit 节点数量，本例子为3 。执行前述命令后会出现如下内容：

具体意思大家可以详读上面的具体内容。接下来是比较重要的一步，将后面两个commit 的信息进行压缩，也就是将pick 改成s (代表squash ）。

然后根据提示，进行保存退出。在接下来出现的界面中，根据提示修改commit 信息：

保留想要的commit 信息，不想保留的可以以# 进行注释即可。比如本例注释后面的两行，只保留第一行：

保存并推出。

第三步：再次查看 git log

可以看到前三个commit 信息被整合成了一个。接下来只需要将修改推送至远端仓库即可。

第四步：推送至远端仓库

将rebase 结果推送至远端仓库。这儿需要注意的是，必须用-f 或者--force 来完成强制推送，否则会报如下错：

使用git push -f 或者git push --force 来完成强制推送。（推送分支基于大家自己的选择）

随后即可看到，推送成功的信息

大家可以在github 对应的PR 上看到信息已经被合并成了一个。

Envoy 中文翻译总结

Envoy 1.6 官方文档翻译是从启动，到 4 月底结束了最后一篇的翻译。前后历经半年，完成了 347 篇文档的翻译。共有有 47 位同学认领了文档的翻译工作，同时有 46 位同学参与了翻译的校对。

访问地址：

这并不是结束

虽然文档翻译的工作已经结束，但翻译的打磨还会继续。在文档的使用过程中，如果任何问题，欢迎到中提出，也欢迎提交 PR 修正。

后续活动

安排视频会议，大家一起聊聊翻译的那些事。

时间与人员待定。

最后

再次感谢各位参与者的辛苦付出。

Envoy 常见编译问题

本地文档编译

cd envoy/
./ci/run_envoy_docker.sh 'docs/build.sh'

常见的编译问题大概有以下几种，可参考进行修改。

1 汉语下面的下划线长度不能小于汉语长度

正确示例如下：

Google 漏洞奖励计划（VRP）
=======================

错误示例如下：

Google 漏洞奖励计划（VRP）
==============

如用上述错误示例翻译，则在编译时候会出现如下错误：

2 超链接前后需要加空格

正确示例如下：

:ref:`威胁模型 <arch_overview_google_vrp_threat_model>` 保持一致。

请注意符号 ` 和保持两个汉字之间须加一个空格。

错误示例如下：

:ref:`威胁模型 <arch_overview_google_vrp_threat_model>`保持一致。

如按照上述错误示例翻译，会出现如下所示的错误：

3 `rst` 的链接内容可不用翻译

如下内容，只需要将 Observability 翻译为观测性即可，其他内容（如 statistics ）不用翻译，否则会编译失败。

Observability
=============

.. toctree::
  :maxdepth: 2

  statistics
  application_logging
  access_log/access_log.rst

正确翻译示例如下：

观测性
======

.. toctree::
  :maxdepth: 2

  statistics
  application_logging
  access_log/access_log.rst

错误翻译示例：

观测性
=============

.. toctree::
  :maxdepth: 2

  统计
  application_logging
  access_log/access_log.rst

多次 commit rebase 为一次进行提交

第一步：查看 git log 确定要 rebase 的节点数

第二步：执行 rebase 命令

执行 git rebase -i HEAD~n ，其中n 代表想要合并的commit 节点数量，本例子为3 。执行前述命令后会出现如下内容：

$ git rebase -i HEAD~3

pick 1f6ee95 add cloud security policy translation
pick 4b59058 fix translation issue
pick f09ff89 fix translation issue

# Rebase d05c0ff..f09ff89 onto d05c0ff (3 commands)
#
# Commands:
# p, pick = use commit
# r, reword = use commit, but edit the commit message
# e, edit = use commit, but stop for amending
# s, squash = use commit, but meld into previous commit
# f, fixup = like "squash", but discard this commit's log message
# x, exec = run command (the rest of the line) using shell
# d, drop = remove commit
#
# These lines can be re-ordered; they are executed from top to bottom.
#
# If you remove a line here THAT COMMIT WILL BE LOST.
#
# However, if you remove everything, the rebase will be aborted.
#
# Note that empty commits are commented out

具体意思大家可以详读上面的具体内容。接下来是比较重要的一步，将后面两个commit 的信息进行压缩，也就是将pick 改成s (代表squash ）。

pick 1f6ee95 add cloud security policy translation
s 4b59058 fix translation issue
s f09ff89 fix translation issue

然后根据提示，进行保存退出。在接下来出现的界面中，根据提示修改commit 信息：

# This is a combination of 3 commits.
# This is the 1st commit message:

add cloud security policy translation

# This is the commit message #2:

fix translation issue

# This is the commit message #3:

fix translation issue

# Please enter the commit message for your changes. Lines starting
# with '#' will be ignored, and an empty message aborts the commit.
#

保留想要的commit 信息，不想保留的可以以# 进行注释即可。比如本例注释后面的两行，只保留第一行：

# This is a combination of 3 commits.
# This is the 1st commit message:

add cloud security policy translation

# This is the commit message #2:

# fix translation issue

# This is the commit message #3:

#fix translation issue

保存并推出。

第三步：再次查看 git log

$ git log

commit ce1339fa6862c440140b9f91ccfd67c4f17d04fe (HEAD -> cloud-security-policy)
Author: majinghe <devops008@sina.com>
Date:   Fri Dec 18 16:42:55 2020 +0800

    add cloud security policy translation

可以看到前三个commit 信息被整合成了一个。接下来只需要将修改推送至远端仓库即可。

第四步：推送至远端仓库

将rebase 结果推送至远端仓库。这儿需要注意的是，必须用-f 或者--force 来完成强制推送，否则会报如下错：

! [rejected]        cloud-security-policy -> cloud-security-policy (non-fast-forward)
error: failed to push some refs to 'git@github.com:majinghe/cloudnative.to.git'
hint: Updates were rejected because the tip of your current branch is behind
hint: its remote counterpart. Integrate the remote changes (e.g.
hint: 'git pull ...') before pushing again.
hint: See the 'Note about fast-forwards' in 'git push --help' for details.

使用git push -f 或者git push --force 来完成强制推送。（推送分支基于大家自己的选择）

随后即可看到，推送成功的信息

Counting objects: 16, done.
Compressing objects: 100% (16/16), done.
Writing objects: 100% (16/16), 259.38 KiB | 891.00 KiB/s, done.
Total 16 (delta 6), reused 0 (delta 0)
remote: Resolving deltas: 100% (6/6), completed with 6 local objects.
To github.com:majinghe/cloudnative.to.git
 + 4b59058...ce1339f cloud-security-policy -> cloud-security-policy (forced update)

大家可以在github 对应的PR 上看到信息已经被合并成了一个。

云原生社区 Envoy SIG

欢迎

加入 Envoy SIG

如何提问

联系

Envoy 官网翻译（1.16版本）

Envoy 中文翻译流程

前提条件：

加入翻译团队

开始翻译

加入 Review 团队（Optional）

rst 在线检测工具

Envoy 中文翻译成员及优秀人员

Envoy 翻译负责人

参与翻译人员

优秀翻译及 Review 人员

Envoy 翻译进度

第一阶段

第二阶段

第三阶段

第四阶段

第五阶段

第六阶段

Envoy 常见编译问题

本地文档编译

1 汉语下面的下划线长度不能小于汉语长度

2 超链接前后需要加空格

3 rst 的链接内容可不用翻译

多次 commit rebase 为一次进行提交

第一步：查看 git log 确定要 rebase 的节点数

第二步：执行 rebase 命令

第三步：再次查看 git log

第四步：推送至远端仓库

Envoy 中文翻译总结

这并不是结束

后续活动

最后

Envoy 翻译进度

第一阶段

第二阶段

第三阶段

第四阶段

第五阶段

第六阶段

Envoy 中文翻译成员及优秀人员

Envoy 翻译负责人

参与翻译人员

优秀翻译及 Review 人员

欢迎

加入 Envoy SIG

如何提问

联系

Envoy 常见编译问题

本地文档编译

1 汉语下面的下划线长度不能小于汉语长度

2 超链接前后需要加空格

3 rst 的链接内容可不用翻译

Envoy 中文翻译总结

这并不是结束

后续活动

最后

多次 commit rebase 为一次进行提交

第一步：查看 git log 确定要 rebase 的节点数

第二步：执行 rebase 命令

第三步：再次查看 git log

第四步：推送至远端仓库

Envoy 中文翻译流程

前提条件：

加入翻译团队

开始翻译

加入 Review 团队（Optional）

rst 在线检测工具

`rst` 在线检测工具

3 `rst` 的链接内容可不用翻译

3 `rst` 的链接内容可不用翻译

`rst` 在线检测工具