Bootstrap

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

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

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

社区翻译任务类型

当前,社区文档翻译任务分为三种:

  • Apache Pulsar 官方文档翻译:主要任务是将 Apache Pulsar 网站上的英文文档翻译为中文,让更多中文用户更加容易阅读。翻译平台使用 Crowdin 进行翻译提交、管理和审核;

  • Apache Pulsar 英文博客翻译:内容范围较广,主要聚焦技术原理、案例等方向,英文文章翻译在释放给社区成员翻译之前,我们均已取得原文作者授权;

  • Apache Pulsar Weekly(周报)翻译:内容主要聚焦 Apache Pulsar 社区当周的亮点、重要特性、重要 bug 修复、活动和新闻、技术博文推荐几个板块。

术语库

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

术语表地址:https://shimo.im/sheets/5jozGy5WIUQQf5JV/MODOC

翻译流程

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

使用 Crowdin 翻译技术文档

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

  • 未翻译内容为红色

  • 已经翻译待 Review 内容为淡绿色,文本为灰色

  • 管理员已经 Review 的内容为绿色,文本为黑色

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

翻译英文博客

译者指南:

  • 请将每段的翻译一一对应放在相应段落下面,方便审核;

  • 全文请按照 Markdown 格式进行编写,包括文章代码、标题、超链接、引用等等;

  • 请在文章开头添加个人简介。感谢每一位翻译的志愿者,我们希望能让社区看到你的付出;请在阅读后将译者指南删除。

翻译 Weekly(周报)

译者指南:

  • 需向周报内填充的内容有:贡献者名单、(本周亮点)、重要特性、重要 bug 修复、活动和新闻、博文推荐、结尾的 Pulsar 社区数据几个板块;

  • 周报原文来自最新一期的 ,请复制后放在相应的板块内;

  • 每个部分皆有示例,注意事项请仔细阅读并参考其中的进行编辑翻译;

  • 注意事项:

  • 中英文之间需空格;

  • 请在每段英文下方写下对应的中文翻译。

  • 博文推荐需集合英文周报内 blog 与本期间微信公众号上 Pulsar 相关内容;

  • 文档全篇请采用 markdown 格式,以便排版;

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

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

Apache Pulsar GitHub 仓库在此期间 merged PR 的贡献者名单,地址:https://github.com/apache/pulsar/pulls?q=is%3Apr+is%3Aclosed

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

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

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

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

,欢迎请扫描下方二维码回复「志愿者」加入我们,赶紧行动起来吧!

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