操作指南｜最详尽文档翻译志愿指南

作为 Pulsar 社区的一员，想为社区做贡献却没有头绪吗？最详尽文档翻译指南来啦！Pulsar 中文社区贡献者并不局限于贡献代码，撰写、翻译文档也可以成为另一种意义上的 Pulsar Contributor！

本次为不熟悉文档翻译志愿工作的小伙伴们带来文档翻译贡献指南，手把手带你熟悉如何进行社区志愿贡献！

社区翻译任务类型

当前，社区文档翻译任务分为三种：

• Apache Pulsar 官方文档翻译：主要任务是将 Apache Pulsar 网站上的英文文档翻译为中文，让更多中文用户更加容易阅读。翻译平台使用 Crowdin 进行翻译提交、管理和审核；
• Apache Pulsar 英文博客翻译：内容范围较广，主要聚焦技术原理、案例等方向，英文文章翻译在释放给社区成员翻译之前，我们均已取得原文作者授权；
• Apache Pulsar Weekly（周报）翻译：内容主要聚焦 Apache Pulsar 社区当周的亮点、重要特性、重要 bug 修复、活动和新闻、技术博文推荐几个板块。

术语库

为了保证英文术语翻译的统一，方便大家理解，我们长期以来都在维护与 Apache Pulsar 相关的术语库，目前术语库词条已达 500 余条。建议在进行官方文档和英文博客翻译前，仔细阅读术语库，降低后续翻译审阅工作量。

术语表地址： https://shimo.im/sheets/5jozG...

翻译流程

参与文档、博客翻译工作，简要步骤如下：

1. 扫描文末二维码添加 Pulsar Bot 好友，回复「志愿者」加入 Pulsar 中文社区志愿者微信群，在 Translation Library 翻译内容看板认领（在认领的Issue 上评论留言，并在群内@管理员 Tango 留言 Issue 序号进行认领）
2. 点击认领的 Issue 任务，根据不同翻译任务类型进入 Crowdin 平台或 Google Docs
3. 注册/登录自己的 Crowdin 账号或 Google 账户（建议使用谷歌邮箱登陆）
4. 开始进行 Issue 任务
5. 任务完成后联系管理员进行审核工作

使用 Crowdin 翻译技术文档

1. 请注意，把 Crowdin 圈红处须设置成如图所示（突出显示未翻译、已翻译和 Review 后的字符串，以及是否显示中文预览），方便详细的分辨需翻译的内容。

2. 此处的 ID、Lable 我们一般不翻译，保留英文。

3. Crowdin 的翻译是分段的，所以我们需要提前选定点击所想要翻译的英文段（如图左侧红色区域），系统会在右上角（圈红区域）自动生成默认文本，在蓝色区域内输入我们翻译的内容。

4. 文本中黄色内容为默认链接，翻译时保持原状即可（可以点击上方黄色区域自动复制或点击左下角红框内的按钮进行全文本复制后替换其中的英文）。

5. Crowdin 自带翻译校对区域（如下图圈红区域，内容翻译仅供参考），所以在翻译过程中大家可以参考此处内容，但须避免“翻译腔” 。

6. 如何辨识 Crowdin 需完成的内容：

• 未翻译内容为红色
• 已经翻译待 Review 内容为淡绿色，文本为灰色
• 管理员已经 Review 的内容为绿色，文本为黑色

我们的目标就是把所有的红色区域全部变成绿色！以上为 Crowdin 的基本操作，你 get 了嘛？

翻译英文博客

1. 打开认领的 Issue，圈红部分为文档翻译的指南：

译者指南：

• 请将每段的翻译一一对应放在相应段落下面，方便审核；
• 全文请按照 Markdown 格式进行编写，包括文章代码、标题、超链接、引用等等；
• 请在文章开头添加个人简介。感谢每一位翻译的志愿者，我们希望能让社区看到你的付出；请在阅读后将译者指南删除。

2. 请在每段英文下方写下对应的中文翻译。3. 完成后在群内同步，编辑将邀请来自 StreamNative 和社区的技术专家对文章翻译进行审阅。4. 译者确认审阅意见，定稿。

翻译 Weekly（周报）

1. 打开认领的 Issue 内的文档链接，圈红部分为周报翻译指南：

译者指南：

• 需向周报内填充的内容有：贡献者名单、（本周亮点）、重要特性、重要 bug 修复、活动和新闻、博文推荐、结尾的 Pulsar 社区数据几个板块；
• 周报原文来自最新一期的 Pulsar Community Weekly Update，请复制后放在相应的板块内；
• 每个部分皆有示例，注意事项请仔细阅读并参考其中的示例样式进行编辑翻译；
  注意事项：
• 中英文之间需空格；
• 请在每段英文下方写下对应的中文翻译。
• 博文推荐需集合英文周报内 blog 与本期间微信公众号上 Pulsar 相关内容；
• 文档全篇请采用 markdown 格式，以便排版；

2. 点击右上角编辑模式（Editing）进行翻译编辑。

3. 按照文档内圈红位置示例填充（本周亮点）、重要特性、重要 bug 修复几个板块。

4. 更新活动和新闻模块（此处须放上该周内 Apache Pulsar 公众号发布最新的活动、新闻动态内容）如下图圈红区域。

5. 博文推荐模块（如上图圈蓝处需放上该周内周报内博文部分与 Apache Pulsar 公众号发布的中文博客链接）。
6. 更新结尾的译者简介及 Pulsar 社区数据（如下图圈红区域）。

• Pulsar 社区贡献者、Star、Fork 数量更新位置请参考本链接：https://github.com/apache/pulsar ，如下截图圈红位置：

• Contributor 数量更新位置如下图：

7. 请更新导语部分的贡献者名单及该周周报的具体日期（如图圈红位置）。

Apache Pulsar GitHub 仓库在此期间 merged PR 的贡献者名单，地址： https://github.com/apache/pul...

8. 完成后请在群内同步，编辑将邀请来自 StreamNative 和社区的技术专家对文章翻译进行审阅。
9. 译者确认审阅意见，定稿。

文档翻译贡献制度-积分制

在 Pulsar 社区，为社区出力的方式多种多样，不只是代码的贡献者，如果你对文档和内容的翻译整理、活动的组织策划、社区的运营感兴趣，都可以成为志愿者的一员。

Pulsar 社区志愿者采用积分制，并非是为了比较大家贡献的多少，而是记录大家的热情，方便我们定期为积极的小伙伴们定制独有的 Pulsar 志愿者周边来感谢你们的付出和热爱。

目前社区志愿者贡献采用积分制度：定期积分累计清零，将为积分前 3 的小伙伴邮寄一份专属的定制礼品，详情参考下方图片

Pulsar 中文社区正在招募文档翻译志愿者，欢迎请扫描下方二维码回复「志愿者」加入我们，赶紧行动起来吧！

"扫码添加 Bot 好友"

关注公众号「Apache Pulsar」，获取干货与动态