github地址:https://github.com/qiudaoke/flowable-userguide
码云地址:https://gitee.com/Flowable/flowable-userguide
今天Flowable官方正式同意“分享牛”团队负责以及持续跟踪文档的汉化,设计器的汉化工作。这个争取的道路有些艰辛,本来Flowable团队是不愿意其他国家的人去进行文档以及设计器文件的本土化操作的。基于如下几个原因:
Flowable中国社区是由“分享牛”领队并聚合了一帮志同道合(分享牛目前是开源框架Flowable中国社区贡献最多的贡献者,长期的贡献和关注已经得到了Flowable官方的信赖),长期从事工作流的爱好者一起维护。因此上述几个问题均不存在。为此Flowable官方Leader tijsrademakers同意让“分享牛”一群人长期维护文档的汉化,设计器的汉化工作。
一起成为开源代码贡献人员,欢迎大家加入qq交流群为社区贡献添砖加瓦:1023773998
点击链接加入群聊【Flowable官方中国社区群】:https://jq.qq.com/?_wv=1027&k=5tRwTr4
群的主旨是尽量提一些Flowable框架的Bug,本群的爱好者、布道师、贡献者会根据反馈及时快速的修复并让官方合并。如果对于官方的汉化文档有歧义,我们也会快速进行修复。
如果觉得文档PR操作比较繁琐,可以直接现在GitHub issue中认领任务。然后直接下载文件,在Idea中打开,汉化之后,发到群文件也可以。
天下事有难易乎?为之,则难者亦易矣;不为,则易者亦难矣。文档汉化虽然简单,但是也需要有一定的BPMN/DMN/CMMN功底。如果对于上述的几个规范协议一无所知,也没有关系。我们重在参与。相信如果自己即使一点也不懂,但是经过长时间的文档通读和翻看其他贡献者的汉化记录,也会知其然。所谓熟能生巧就是这个道理。因为参与文档汉化的人员比较多,知识体系良莠不齐。为此我们必须要有高质量的翻译和校稿团队,才能保证尽可能的让翻译汉化的成果更好,为此我们专门开了一个项目,大家可以随时提交自己的翻译结果并联系分享牛、Activiti权威指南一书作者张志祥、郑州轻工业大学软件学院的张志峰教授一起把关、把脉。最后有“分享牛”一起提交到官方,文档中会罗列每一位贡献者的名字。争取让社区的力量发挥到极致,将错误概率降到最低。相信通过大家的努力我们会做的更好,走的更远,站得更高。
再次感谢每一位辛勤付出的贡献人员。
下文重点说一下文档汉化的注意点。
项目托管于GitHub中,地址:https://github.com/qiudaoke/flowable-userguide
1、在浏览器打开上述的URL之后,可以“Start”下这个仓库,然后点击“Fork”按钮。
2、fork的前提是大家需要进行登录GitHub。
3、fork之后,该仓库内容会自动同步到GitHub登录用户的仓库中。
4、通过命令行或者客户端下载源代码即可。
5、自己仓库的代码怎么跟源仓库内容更新呢?
git remote -v
git remote add upstream [email protected]:qiudaoke/flowable-userguide.git
git fetch upstream
git merge upstream/master
git push
建议大家直接使用Idea开发工具,直接将下载之后的源码导入即可。
Idea需要安装一下AsciiDoc插件,如下图所示:
1、前提是自己进行了本地仓库文件有改动并且要提交才去这个操作。PR之前需要自己新建一个分支,然后切换到新建的分支,进行代码的提交和推送即可。下面是test分支的建立命令:
git branch test
git checkout test
2、打开地址:https://github.com/qiudaoke/flowable-userguide
点击“New pull request”按钮
为了保证没一个版本都是高可用的,我在这个仓库中为每一个版本都新建了一个文件夹。这样咱们就能保证每一个版本的文档,下载下来就可以直接用。如下图所示:
点击该目录进去,如下图所示:
我们直接去找到flowable-userguide/V6.5/docs/userguide/src/zh_CN目录,打开里面.adoc文件进行汉化即可。
只要大家在idea中安装了上文提到的AsciiDoc插件,随便打开一个adoc文件就可以实时看到预览图,如下所示:
类似include::标签不要动,这个就是引入其他文件的标志。
汉化的过程中,原有的内容不要删除,方便后续咱们一起校稿对比。在汉化过程中,可以直接复制一个,然后放到下面进行汉化即可(代码不用汉化)。 理想的结构是,一段英文,一段中文。原有的排版尽量别动,这样方便后续的排版。可以保证咱们去做更多有意义的事情。
相信通过大家的努力我们会做的更好,走的更远,站得更高。再次感谢每一位辛勤付出的贡献人员。