Ceph 中文文档
不管你是想为云平台提供Ceph 对象存储和/或 Ceph 块设备,还是想部署一个 Ceph 文件系统或者把 Ceph 作为他用,所有 Ceph 存储集群的部署都始于部署一个个 Ceph 节点、网络和 Ceph 存储集群。
Linux 其它
共52Star
详细介绍
orphan: |
---|
Ceph 文档中文翻译说明
这里是 Ceph 文档中文版的源码,编译好的位于: https://github.com/drunkard/ceph-readable-doc
中文版文档风格
译文的语言风格:
- 通俗易懂,尽量不用生僻的词语,前人没有翻译过的术语、又不太好直译的,想办法用转义、通感之类的修辞方法翻译;
- 尽量用本土化的语言风格;中文就按汉语习惯翻译,不做直译,有时候反而不好理解;
- 废话少说,捞干的。
词语的翻译应该尽量一致,请参考翻译惯例(即 translation-convention.rst )。
尽量遵守原文档的书写风格,如缩进、不超过 80 列宽、等。
有些风格是中文版特有的,如:
- 中文和非中文用空格分隔;
- 插入命令,前一段行尾加空格和双引号(" ::");
- 尽量保留原文的标题、并改为注释或链接,以防别的文档里有(自动生成的)引用,且便于后续更新;如果链接与别的冲突了,可改为注释(行首加两点和空格);
- 用反斜线("\")换行,这样不会额外增加空格,即不留白;
- 原文中用双引号引用的词语在中文文档里可去掉引号,因为原文引用它已经很显眼了;
- 由于字体和程序的问题,在"终端下”能更好地对齐到 80 列,比如在 gnome-terminal + vim 下;
- 为防止中文版和英文版文档的行数差得太多、在后续更新时找不到位置,中文版断行要提前,比如在 64 列左右断行; 断行列数要与 vi_two_files.sh 脚本内的同步;
- 断行尽量避开词语、术语,后续要批量更改的时候方便过滤;
更新步骤
本项目的更新是对照着 Ceph 项目原文和 doc/ 目录相关的 commit 历史进行的,这样就无需挨篇对照。
以下只是大致步骤,路径不同时还需修改脚本:
mkdir /git && cd /git git clone https://github.com/ceph/ceph.git git clone https://github.com/{你的github用户名}/ceph-Chinese-doc.git cd /git/ceph-Chinese-doc/translation_cn/ && ./update-doc.sh # update-doc.sh 脚本用了 git 和 tig 命令,最好先检查下安装了没。 # 对照着 tig 里的 commit 历史开始更新中文文档! # 从第一个 commit 开始更新、翻译。 # 必须按日期更新!!!一次最少要更新一天的,如果遇上 commit 历史交叉得 # 厉害,可能一次必须更新很多天的。 # 更改脚本 ``env.sh`` 里的 SYNC_TO 变量; vi env.sh # 更新 SYNC_TO 变量 # 提交变更 ./commit-updated.sh git push origin
然后可以在 github 上向我反馈您的更新 :-)
文档编译
注意事项:
- Java 虚拟机应该用 oracle-jdk-bin-1.8 或 oracle-jdk-bin-1.7 , jre 缺少必要的库文件。
- Sphinx 文档编译系统是基于 python 的,建议使用 python 3.6 ;
- ditaa 图还不能翻译为中文,因为渲染时的字体问题还未解决;
编译步骤
这些文档从 ceph 源码中的 doc/ 目录翻译而来,结构未变,所以您仍然可以用原文档的构建方法构建此文档。只需用此库替换 ceph 源码库的 doc 目录,具体步骤如下:
你得克隆本文档库,并克隆 Ceph 源码,如:
mkdir /git && cd /git git clone https://github.com/ceph/ceph.git git clone https://github.com/drunkard/ceph-Chinese-doc.git
把源码树里的 doc 目录备份为 doc-en,然后把中文文档库的 ceph-Chinese-doc 目录链接为原 ceph 源码库的 doc ;
cd /git ln -s /git/ceph-Chinese-doc /git/ceph/doc
执行 ceph 库内 admin 目录下的 build-doc 开始构建文档;
cd /git/ceph ./admin/build-doc html man
启动文档服务器,这样就可以通过 http://localhost:8080/ 阅读文档了。
cd /git/ceph ./admin/serve-doc
如果编译失败,请参考此文档(即 build-errors.rst )解决。