PostgreSQL9.5中文手册的翻译提交步骤

帅帅男孩

PostgreSQL 9.5中文手册翻译目前已经开始进行，通过github进行翻译的管理，相关流程和说明请参考

https://github.com/postgres-cn/pgdoc-cn/wiki/pg9.5

本文介绍如何使用git工具提交翻译后的文档(在参与翻译工作前，请务必仔细阅读上面的wiki页面)。

下面的操作均假设在Windows系统上，其它平台的操作类似。

1. 注册github账号
首先你要注册一个github账号，可以进这个页面注册账号 https://github.com/join 。如果你已经有账号了，跳过这一步。

2. 下载安装git客户端
http://git-scm.com/downloads

注：也可以使用你熟悉的其它Git工具，比如Git Extensions。但下面的操作步骤以Git客户端为例子。

3. 打开git bash
进入你的工作目录，点鼠标右键，再在弹出菜单上点击"Git Bash"。

4. 配置git客户端
配置账号和email：
$ git config --global user.name "your_name"
$ git config --global user.email "your_email@example.comm"

账号和email要替换成github上你注册的用户名和邮箱。

生成SSH key：
$ ssh-keygen -t rsa -b 4096 -C "your_email@example.com"

一路回车，会在你用户目录的".ssh"目录(比如C:\Users\Administrator)下生成SSH key，其中id_rsa.pub是你的公钥。
打开https://github.com/settings/ssh，点击"Add SSH key",将id_rsa.pub的内容添加上去。
做完这一步，以后向github仓库push的时候就可以免去认证的麻烦。

5. Fork一个你自己的仓库
打开下面的URL，点击右上角的"Fork"按钮，Fork一个你自己的仓库。以后你的更新都push到自己的仓库，再由自己的仓库发起pull request。
https://github.com/postgres-cn/pgdoc-cn

6. clone你自己的Github仓库到本地
$ git clone git@github.com:your_name/pgdoc-cn.git

把上面的your_name替换成你自己的github用户名。
这里不直接clone原始库到本地的原因在于，你没有原始库的写权限，不能直接往原始库push修改，只能先借助于你自己的Github仓库。


7. 配置本地仓库与原始库同步
$ cd pgdoc-cn
$ git remote add upstream git@github.com:postgres-cn/pgdoc-cn.git


8. 从原始库获取最新的sgml文件到本地
$ git pull -r upstream master:master

9. 修改sgml文件
用你喜欢的编辑器修改sgml文件并保存。
修改完成后，可运行builddoc.bat本地编译一下，然后打开下面的网页预览效果。
pgdoc-cn\postgresql\doc\src\sgml\html\index.html


10. 提交修改到本地库
$ git add .
$ git commit -m "翻译9.5 xxxx.sgml"

add和commit之前最好先用git status确认一下修改了哪些文件，要提交哪些文件。
另外，commit这一步建议通过GUI来做，可以看到要提交哪些文件，输入中文commit说明也更方便。
调出GUI commit 窗口的方法是，点鼠标右键，再在弹出菜单上点击"Git Commit Tool"。

11. push本地库的修改到你自己的github仓库
$ git push origin master:master

12. 通过你的github仓库向原始库发起pull request
下面通过一个例子来说明。
比如，我刚刚按上面的方法修改了bki.sgml，并push到我自己的github仓库。
现在打开我的github仓库https://github.com/ChenHuajun/pgdoc-cn，发现下面的提示画面。


点击"New pull request"，进入下一画面。


确认修改无误后(可以通过看页面下方的文件对比)，点击"Create pull request"。然后进入下面的画面。


输入必要的说明再点击"Create pull request"，修改的pull request就发出去了。
注意上面图片的含义，是指从你自己的仓库(bead fork: ChenHuajun/pgdoc-cn)的master
分支向原始库(base fork:postgres-cn/pgdoc-cn)的master分支发pull request。


13. 再次修改sgml
过了一段时间再次修改其他sgml时，从上面的第8步开始做。因为github原始库里有其他人的更新，第8步可以把这些更新拉过来，保持和原始库的数据同步。