K8SMeetup 翻译流程与翻译校稿规范

K8SMeetup 翻译社区 DashBoard,附每周的翻译文章汇总

  • 翻译流程
    • 讲解译者如何参与 Kubernetes 中文化文档翻译的过程
  • 校稿规范
    • 讲解如何预定翻译文档的校验,以提升翻译质量
    • 提供版本控制与翻译文件更新样例,提示如何更新翻译文件

注:所有的翻译文件,都要保留原文,一段英文,一段中文,且中英文间隔不要太长,以方便大家 review,保证翻译质量。

Kubernetes 翻译流程

参与贡献的主要流程如下:

  • 领取翻译任务
  • 准备翻译文档 Fork 代码到自己的 github 账户
  • 克隆代码完成本地翻译并向 website 提交PR
  • 根据 cncf/cla 会员 review 意见完成修改
  • 管理员审核并完成 PR 合并

参与翻译前必读

Kubernetes 文档校对

为什么要进行校对

文档初稿翻译难免会有不太理想的地方,所以我们希望能有更多人志愿参与校对工作,进一步完善 Kubernetes 中文文档。

Kubernetes 文档的构成

Kubernetes 文档由若干 mdhtml 文档构成,翻译即是将原始 mdhtml文件中需要翻译的文字用 tag 注释包起来,然后再拷贝一份进行翻译。原始英文用符号 <!-- --> 注释掉,每一段英文,对应一段中文,方便其他译者 review,如下例:

<!--
#### Kubernetes is

* **Portable**: public, private, hybrid, multi-cloud
* **Extensible**: modular, pluggable, hookable, composable
-->

#### Kubernetes 具有如下特点:

* **便携性**: 无论公有云、私有云、混合云还是多云架构都全面支持
* **可扩展**: 它是模块化、可插拔、可挂载、可组合的,支持各种形式的扩展

翻译规范

  • 翻译之前,需参考术语表以规范翻译一致性。
  • 译文中的英文与中文建议用空格分隔
  • Kubernetes 资源对象如:DeploymentServiceConfigMap 等不需要翻译,尽可能用原始英文。
  • 翻译的中英文间隔不宜过长,尽可能一段英文注释,一段中文翻译,可以前后对应,方便其他译者协助 review。
  • 保持原始 mdhtml 格式不变,例如 _Server_ 翻译成 _服务器_
  • 对于长文章翻译要注意锚点链接不要移除,例如 [Server](#Client) 翻译成 [服务器](#Client) 锚点链接保留,但不翻译。
  • md 代码块与代码输出内容也不要翻译
  • 如果是多人合译的文章,需要同步好翻译进度

参与规则

  • 校对者只需要具备基本的 kubernetes 知识,能够理解文档中讲述的内容即可
  • 校对作业以 md/html 为单位,但对于很大的 mdhtml 文件,也可以按主题拆分成多份
  • 为了避免不必要的重复翻译或校对,翻译或校对前先在翻译任务中对要翻译或校对的文件进行预定
  • 预定校对作业时,以文件为单位,不建议一次预定太多,希望量力而行
  • 预定了某个 mdhtml 文件并不代表别人不会同时修改此文件,所以如果克隆了git仓库到本地,仍然要注意及时从远程仓库同步更新
  • 如果某个 mdhtml 文件的校对工作进展缓慢,或某个已校对的 mdhtml文件仍有翻译问题,可以对正在校对或已经校对过的文件进行再次校对
  • 由于每个月我们会同步一次最新的版本,需要译者对自己所译的文件内容更新负责
  • 有任何问题,可以发 Issues 或 在微信群里讨论

校对步骤

  • 登录github 如果还没有github账号,先注册一个,然后登录。
  • 校对预定 点击任务分配置表,预定指定的 mdhtml 文件, 在后面填上自己的 github 的用户名,比如 校对预定By:@markthink。 同时把此文件的的状态从Translating改成Under Internal Review,对于很大的文件,也可以只预定其中的一部门标题,比如:校对预定By:[起始标题-结束标题]@markthink
  • 检查译文 对照英文原文检查译文,可以点开对应文件的链接,对照 mdhtml 中被注释的英文原文进行检查(发现问题可以在线修改),或提交 Comment 给译者。
  • 问题纠正 对于译者,如果发现问题,可直接修改 mdhtml文件,对暂时不太好处理的问题可以发行issues报告。
  • 状态更新 校对完成后在[作业分工及进度]中更新校对状态,比如校对完成By:@markthink。同时把翻译文件的的状态从Under Internal Review改成Pull Request Sent

谢谢您!

Kubernetes 在社区参与中茁壮成长,我们非常感谢您对我们的网站和文档的贡献!