Pulsar documentation translation httpscrowdin.comprojectapache-pulsar

Clone this repo:

Branches

  1. becfb3f update a file name (#10) by Jennifer Huang · 3 weeks ago master
  2. a287ae6 Add files via upload (#9) by Sylvia · 3 weeks ago
  3. 3d0bd59 update schedule (#7) by Sylvia · 4 weeks ago
  4. ad6fcfb Merge pull request #6 from ireneontheway/master by Jennifer Huang · 3 months ago
  5. bb6be63 Apply suggestions from code review by ireneontheway · 3 months ago

Translation workflow and guidelines

Welcome to join Pulsar translation project! Before translating, read translation workflow and guidelines.

Workflow

Pulsar 的翻译项目放在 Apache Pulsar Crowdin 上。想进一步了解 Crowdin 功能,参阅 Crowdin 网站 。 我们的翻译流程主要有以下几步。

注册 Crowdin 账号,加入 Pulsar 翻译项目组

登录 Apache Pulsar Crowdin project 页面。如果没有 Crowdin 账户,点击右上角 SIGN UP,输入个人信息创建账户。如果你已经有 Github、Facebook,Google,Twitter,Gitlab 账号,直接在注册页面关联以上任意账号即可。

登录成功后,在右上角选择 Join(加入)

注意
Pulsar 的源文件为英文,翻译项目分为中文、法语和日语。
选择翻译目标语言,点击进入浏览。本文以“简体中文翻译项目”为例。

选择翻译文件,提 PR

点开“简体中文翻译项目”,进入 master > docs 目录中,查看每个文件的翻译进度。 master > docs 目录中的文件是 Pulsar 官网最新版本的源文件,只需要翻译这个目录中的 markdown 文件即可。其中:

  • 绿色:翻译并通过审阅
  • 蓝色:翻译未审阅
  • 灰色:未翻译

根据自己对 Pulsar 及相关技术的理解,优先选择自己熟悉、尚未翻译的内容进行翻译。

选择要翻译的文件后,查看 Translation schedule 中是否有其他人在翻译这个文件。如果已经有,可以重新选择;如果没有,创建一个 PR,把自己要翻译的文件和姓名分别添加进 Translation schedule,提交 PR。

打标签

  • Reviewers:无需设置,负责人会自动收到您提交的 PR 申请,会安排人员处理。
  • Assignees:选择您自己,方便你后续收到进度通知。
  • Label:选择 translation

翻译

译者开始翻译。在打开的翻译界面,文件 id 不需要翻译。翻译中的 tag 和源文件保持一致。

重要
一定不要修改、遗漏 tag,或者在 tag 后面加空格。tag 遗漏或错位会造成中文网站内容显示错乱。

如果看到有翻译需要修改的地方,直接在翻译界面修改、保存。你的翻译结果会自动出现在翻译列表的最上方,Crowdin 会自动记载不同译者的翻译版本。右下方的 TM AND MT TRANSLATION 中会提供 Pulsar、Crowdin 和网站上其他的术语库,翻译时可供参考。

翻译过程中,如需参考或者追加 Pulsar 文档术语库,可以使用 Pulsar 文档翻译术语库

审阅

翻译完成后,在您提交的 PR 页面留言告知:
“I've finished translation, could you please help review?”

Reviewer 收到通知后,开始审阅翻译内容。审阅完成后,在 PR 中告知译者,并做简单点评反馈。如有需要讨论的地方,可以直接在 PR 中交流讨论。

审阅无误后,reviewer approve 该 PR,并 merge。

The following image gives a general workflow. The workflow source file is shared at lucidchat.
Masakazu shares a more detailed swimlane for the workflow.

Guidelines

本规范主要列出了一些常见的翻译问题,并提供了一些指导意见和建议。开始翻译前,请认真阅读并尽量遵守本文的规范,这能有效提高 Pulsar 翻译文件质量,统一翻译风格。

1. 专有名词

涉及到 Pulsar、Pulsar Functions、BookKeeper、ZooKeeper,按照上述大小写格式,保留英文不翻译。
涉及到 broker,bookie,proxy 等,在句中保持英文小写形式,不用翻译。
涉及到 topic,producer,consumer 等,翻译成“主题”,“生产者”,“消费者”。

更多有关 Pulsar 文档术语库,参考 Pulsar 文档翻译术语库。欢迎在这个文档补充和修改术语库。

2. 汉字与英文、数字之间需空格

汉字与英文或数字之间以空格隔开,以增强中英文混排的美观性和可读性。

  • Apache Pulsar是一个开源的分布式发布-订阅消息系统,由Apache软件基金会管理,并于2018年9月成为Apache顶级开源项目。❌

  • Apache Pulsar 是一个开源的分布式发布-订阅消息系统,由 Apache 软件基金会管理,并于 2018 年 9 月成为 Apache 顶级开源项目。✅

**注意:**中文标点符号前后不需要跟空格,即使前后挨着的是英文单词。

3. 中文标点符号

中文里面请使用中文标点符号。英文中没有顿号,应该使用顿号的地方在英文中一般使用的是逗号,在翻译时应注意将其翻译为顿号。比如 “Kubernetes, Mesos, Docker“ 应该翻译成 “Kubernetes、Mesos、Docker“。

在涉及到多个 items 时,如果是短语,后面用分号(;)结束,最后一个 item 以句号(。)结尾。

如果每个 item 是个句子,或者已经使用过分号(;),每个 item 以句号结尾。