Skip to content

Home

Jump to bottom
Yingminzhou edited this page Nov 21, 2016 · 6 revisions

MongoDB 中文文档翻译工作组

###########################

项目介绍

根据DBEngine做的调查，MongoDB是目前最流行的NoSQL数据库。但是目前为止MongoDB并无中文文档。很多同学们在学习MongoDB的时候可以参考一些已有的中文书籍和博客。但是这些中文书籍和博客往往不能全面涵盖用户所需要的内容，而且很多时候上面的内容未能及时更新并与最新版本的功能脱节。这个项目希望利用强大的社区力量来共同完成中文文档的翻译。

项目成员

MongoDB翻译成员由两个团队组成：审核组和翻译组。审核组成员有直接提交权限，并且负责对翻译成员提交的pull request进行审核的工作。

我为什么要来参与翻译？

  • 是一个很好的深入学习MongoDB的机会，所有翻译将会有MongoDB原厂技术人员审核
  • 文档页面将会显示翻译者简单信息
  • commit记录会被收录到官方repo
  • MongoDB中文官方社区VIP
  • MongoDB公司纪念品

对翻译人员的要求

  • 对开源软件有热情
  • 熟悉MongoDB
  • 每周可以拿出一部分时间进行文档翻译工作
  • 能够接受项目组织者的协调安排

特殊贡献者额外福利

  • MongoDB Masters 推荐
  • MongoDB官方认证费用减免申请（150美元）
  • MongoDB中国大会特邀嘉宾（特殊贡献者提供差旅费）

特殊贡献者评价标准

  • 每周翻译或审稿的数量和质量
  • 审核组成员进行整体评定

如何参与

  • 申请加入QQ群 201425357
  • 在QQ群里提供你的Github账号，如没有请到 github.com注册一个，并将群昵称改为自己的Github账号名
  • 网上签订MongoDB的开源提交者协议 http://www.mongodb.com/legal/contributor-agreement
  • 阅读下面翻译流程

翻译流程

第一步： 浏览文档

在 中文文档网站 (docs.mongoing.com) 上浏览相关的页面，遇到自己希望翻译的文章，可点击“翻译或纠错本页面”按钮，跳转到相应的Issue界面。

第二步： 了解任务并领取任务

每个工单里面有两个URL，如下：

PO File: https://github.com/tjworks/docs/blob/master/locale/zh/LC_MESSAGES/release-notes/drivers-write-concern.po

English Page: http://docs.mongodb.org/manual/release-notes/drivers-write-concern

PO File： 点击该链接则会跳转到相应的PO文件，自动Fork相应文件，您可以直接编辑该文件。

English Page: 这个是官方文档的英文页面，可以在翻译的时候作为一个参考用。

了解清楚之后，请在该Issue下面直接以下面的格式进行评论：

（您的github用户名） 正在翻译 表示该任务已被领取 如果该Issue已经有人在翻译，可以选择其它Issue。

第三步 翻译PO文件

点击PO文件的链接，进入到PO页面，点击右上角的“Edit”按钮（会自动Fork），在你自己的fork里翻译相应PO 文件

  • 对里面的每一个MSGID，在MSGSTR字段里提供中文翻译

  • 保存修改。IMPORTANT：修改完成后，请在project中发起一个pull request，请在Commit changes的表单字段输入一个简短的对所做修改的概括，并包括Issue #, 如：

    • Issue #100: Completed translation

  • 1-2个工作日内将会由核心组成员对翻译进行审核，如果通过，merge pull request， 并且将会在该Issue 上 添加 translated，表示该文章翻译结束

其它

如果你打算翻译不止一篇文章，我们建议你把文档的源代码用Git下载到本地，并用一个PO文件编辑器来进行翻译。使用PO编辑器的好处是可以防止出现一些无意破坏PO格式的情况。

一个不错的PO编辑器：

http://poedit.net/download

请注意随时参考 Glossary 页面，对常用名词要使用统一的翻译。

直接翻译PO文件须知（不使用PO文件编辑器）

  • 以 # 开头的是注释行，请勿做任何改动。翻译时请忽略。
  • PO 文件由多个 msgid/msgstr 组成。msgid就是英文原文，不要对其做任何改动。把中文翻译放在msgstr里面。如：

::

# bdb3f48a089b4392bb14128e57e34bc9
#: ../source/core/data-model-design.txt:5
msgid "Data Model Design"
msgstr "数据模型设计"
  • 翻译段落需要分行的时候，段落的分行必须紧接着 msgstr "" 之后，每一行以英文双引号开始和结尾：

::

    # 94fe841ab23f41b6a43915a52482af9f
#: ../source/core/data-model-design.txt:19
msgid ""
"With MongoDB, you may embed related data in a single structure or document. "
"These schema are generally known as \"denormalized\" models, and take "
"advantage of MongoDB's rich documents. Consider the following diagram:"
msgstr ""
"在MongoDB里面，你可以把相关的数据包括在一个单个的结构或者文档下面。"
"这样的数据模式也叫做 \"非规范化\" 模式，它充分利用了MongoDB的灵活文档格式的功能。"
"以下图为例："

使用中文标点符号


* 双引号请统一用英文半角格式。
* 句点和逗号，请使用中文全角格式。

保留restructredText的Markup

PO文件中有一些restructuredText格式用来表示格式或者引用的特殊字符串（Markup）。翻译的时候要注意不要改动这些字符串以保证生成的文档和英文版的格式一致。下面是一些常见的Markup：

  • 在 .. 和 :: 中间的内容， 如: .. default-domain:: mongodb
  • 超链接， 如: http://support.microsoft.com/kb/2731284
  • 在两个 tick 符号之间的内容，如: `auth` setting中的“auth”
  • 下划线开头或结尾的单词或短语，如: _manually-create-windows-service
  • 冒号开头的单词或短句， 如: :program:`mongod.exe`

碰到在段落中间的引用，如：

 请参见 :ref:`security-port-numbers` 。

一定要在引号两头各留一个空格

Clone this wiki locally