https://github.com/vertx-china/vertx-web-site
https://github.com/vertx-china/vertx-china.github.io
这是针对 Vert.x 官方文档中文翻译的仓库。
当前文档翻译对应版本:Vert.x 4.0.0。
在线地址:https://vertxchina.github.io/vertx-translation-chinese
随着 Vert.x 在中国越来越受到关注,使用人数也越来越多,但相关的中文文档却寥寥可数,在这样的背景下,Vert.x 中国用户组发动社区内的志愿者翻译 Vert.x 官方文档。
翻译三个境界:信,达,雅。
我们力求做到第一境界即可。信:即译文要准确,不偏离,不遗漏,也不要随意增减意思。
本着开源的精神,贡献先于索取,自愿自发的为社区,为社会贡献,才能为后人造福。
使用本仓库进行翻译工作的协作。git 主要分为两个分支,master
为主版本分支,主要进行里程碑式的发布;dev
为开发分支,日常的提交都在 dev
分支上边。基本两个分支足够使用,但可以根据每个人的喜好创建个人分支,不做约束。
- 确定翻译内容后,将会把内容分模块,每人根据自己实际的时间情况领取翻译
- 每个模块由一人主导翻译,二人主导校对,校对的人反馈给翻译的人修改,或获得同意后直接修改,三人都确认无误后,合并到主分支上。
- 翻译人员在领取翻译任务后尽可能在自己评估的时间内完成,校对人员校对任务同理,如无法完成则告知大家,多次无理由延期的,自动退出翻译小组。
具体见翻译计划文档。
本项目的在线版本部署在 Github Pages 上。使用 master
分支的 docs
目录作为生成的 GitBook 站点。以下是构建方法:
安装 Node.js 和 npm
https://nodejs.org/en/download/
安装 GitBook 命令行工具
sudo npm install gitbook-cli -g
构建 GitBook
进入项目根目录,执行构建:
rm -rf docs && gitbook build ./ docs
构建之后将 docs
目录的所有更新提交。
注意:一定要输出到
docs
目录,才能被 git pages 识别。
Vert.x中国用户社区默认获得所有翻译内容的发布权。
每个翻译模块归属于翻译者所有,如果需要发布不属于自己翻译的模块,那么需要与翻译者协商获得许可后发布。