Page tree
Skip to end of metadata
Go to start of metadata

文档翻译要求

文档翻译工作由大家协作完成,每个人的习惯有所不同,为了使翻译内容整齐规范,建议大家翻译时参照本规范翻译文档内容和整理文档格式。具体内容如下:

  • 翻译前请先阅读《术语表》,文中术语尽量按照术语表翻译,以免产生歧义;对于一些专有名词,容易引起歧义的单词,可以保留原单词不做翻译。
  • 文档语句采用逐字逐句“正翻”的方法,不可自由发挥,确保翻译的严谨性,但是为了保证语义通顺,请合理地调整语序,我们知道英文的语言习惯和中文是不一样的;
  • 在中文语句中出现的英文单词,应在英文单词前后各空一格,使文档保持美观。除非和英文单词相邻的是标点符号,这种情况可不加空格。
  • 翻译语句的标点符号请使用中文标点,避免中英文标点混用的情况。提示:英文中没有顿号“、”,所以都使用逗号“,”表示停顿,在中文翻译中请使用“、”替换。
  • 对于文中的引用、代码块、超链接,其内容可以保持原文,不强制要求翻译
  • 原文语句中的加粗、重点、斜体等标记,在翻译时也应该同样标记出来。

翻译流程

1、前期工作

1) 注册 Github 账号,将官方仓库 Fork 到自己的仓库。

2) 下载 git,https://www.git-scm.com/download/,安装运行 gitbash。

3) 设置 SSH:

a) 打开 git bash,输入命令:

ssh-keygen


cat .ssh/id


git config --global user.name "自己的名字或者GitHub账户名字"
git config --global user.email 自己GitHub的认证邮箱账户


b) 打开 github 网页,网页右上角 settings – SSH and GPG keys – New SSH key。将 cat 命令打印的内容拷贝粘贴到 New SSH key 里面。


4) 克隆仓库并更改 branch

a) 打开 github,找到自己 fork 的仓库,clone with SSH,复制


b) 打开 git bash,粘贴复制的内容
git clone git@github.com:自己的/fabric-docs-cn.git

cd fabric-docs-cn
git status

c) 切换 branch(从master到1.4.0_zh-CN 或者其他需要翻译的分支)
git branch –a
git checkout -b 1.4.0_zh-CN

2、认领任务

1)  查看 issue 列表,找到没有认领的任务,添加“assign me”评论,然后等待管理员将任务分配给你。

2) 如果issue中没有列出你要翻译的内容,在确保该内容没有人翻译的情况下,添加新issue,并添加“assign me”评论。

3)管理员将任务分配后,即可开始翻译。

4)任务自被分配之日起两周未完成的将被取消,需要重新申请。

3、翻译上传

1)  编辑中文版(位置目录:fabric-docs-cn/docs/source)

选择合适的 md/rst 格式文件编辑器( typora,VSCode,Atom,vim等),直接编辑对应文件。(如有 IDE 则可直接编辑,rst 可在 http://rst.ninjs.org/ 上审阅)
注意格式:斜体、粗体、超链接、注释……

2) 提交更改、signoff 及合并

cd fabric-docs-cn
查看文件变化:git diff (Ctrl+c退出)
git add docs/source/文件名
Signoff提交:git commit -s m "这里用英文写本次提交翻译了什么"   (注意加 “ -s” 参数)
git push

3)  打开Github:Pull request – New pull request,比较上传,申请合并(填写描述)

4、查看翻译文档

PR 被 merge 之后请去中文文档查看翻译内容是否已更新,如果没有更新请联系管理员。

5、其他翻译方式

目前我们正在尝试新的翻译方式,但技术路线尚未成熟,Fabric 2.0 的文档在尝试使用 Transifex 进行协作翻译,欢迎尝试

以下是新的翻译方式的简要说明:

  • 文档翻译采用 transifex.com 在线翻译平台。
  • 翻译志愿者只需要登录transifex.com 加入要翻译的项目,就可以翻译。
  • 翻译完成的文档经过review后,由各项目的maintainer下载,并且上传到主文档的repo上(例如fabric gerrit或者github)
  • 文档维护者维护者在readthedocs.io上从github同步文档以及翻译后的文档,并且buid成html,pdf等格式,
  • 用户访问项目文档地址访问,如fabric https://hyperledger-fabric.readthedocs.io/,用户可以通过点击左下方的绿色版本文字进行语言和版本切换。如下图所示:

 


文档翻译地址: 


加入方法:

  1. 免费注册一个https://transifex.com/ 账号,或者关联自己的github,facebook等账号
  2. 访问想要翻译的项目(地址见上表),选择 Help Translate

进入项目之后选择 Translate


翻译界面如下:

左侧红色为原文,绿色框内为当前翻译的内容,右侧蓝色为原文参考,把自己翻译的中文内容输入右侧下方黄色框内。

6、其他参考文档

  1. 操作说明文档fabric1.2翻译指南.docx
  2. 1.1.0版本的操作文档:如何参与hyperledger中文翻译工作.pdf

这两个是早期版本的文档,仅供参考


  • No labels