Ceph 文档(中文版)

栏目: 服务器 · 发布时间: 6年前

内容简介:Ceph 文档(中文版)

Ceph 文档中文翻译说明

这里是 Ceph 文档中文版的源码,编译好的位于: https://github.com/drunkard/ceph-readable-doc

中文版文档风格

词语的翻译应该尽量一致,请参考:doc:`/translation-convention`。

尽量遵守原文档的书写风格,如缩进、不超过 80 列宽、等。

有些风格是中文版特有的,如:

  • 中文和非中文用空格分隔;
  • 插入命令,前一段行尾加空格和双引号(" ::");
  • 尽量保留原文的标题、并改为链接,以防别的文档里有(自动生成的)引用,且便于后续更新;如果链接与别的冲突了,可改为注释(行首加两点和空格);
  • 用反斜线("\")换行,这样不会额外增加空格,即不留白;
  • 原文中用双引号引用的词语在中文文档里可去掉引号,因为原文引用它已经很显眼了;
  • 由于字体和程序的问题,在"终端下”能更好地对齐到 80 列,比如在 gnome-terminal + vim 下;
  • 为防止中文版和英文版文档的行数差得太多、在后续更新时找不到位置,中文版断行要提前,比如在 64 列左右断行;

更新步骤

本项目的更新是对照着 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/ && ./update-doc.sh
# update-doc.sh 脚本用了 git 和 tig 命令,最好先检查下安装了没。
# 对照着 tig 里的 commit 历史开始更新中文文档!
# 从最下面的 commit 开始翻译!!!

# 更新一或多个 commit 后提交到 git 库:
./commit-updated.sh
git push origin
vi update-doc.sh        # 更新 SYNC_START 变量

然后可以在 github 上向我反馈您的更新 :-)

文档编译

  1. Java 虚拟机应该用 oracle-jdk-bin-1.8 或 oracle-jdk-bin-1.7 , jre 缺少必要的库文件。

  2. 编译系统是基于 python 2 的,还不支持 python3 ,会遇到语法错误。在 Gentoo/Funtoo 下如果环境不对,可以这样临时地切换到 python2.7 :

    eselect python set python2.7
    ln -sf /usr/bin/python2.7 /usr/bin/python
  3. ditaa 图还不能翻译为中文,因为渲染时的字体问题还未解决;

编译步骤

这些文档从 ceph 源码中的 doc/ 目录翻译而来,结构未变,所以您仍然可以用原文档的构建方法构建此文档。只需用此库替换 ceph 源码库的 doc 目录,具体步骤如下:

  1. 你得克隆本文档库,并克隆 Ceph 源码,如:

    mkdir /git && cd /git
    git clone https://github.com/ceph/ceph.git
    git clone https://github.com/drunkard/ceph-Chinese-doc.git
  2. 把源码树里的 doc 目录备份为 doc-en,然后把中文文档库的 ceph-Chinese-doc 目录链接为原 ceph 源码库的 doc ;

    cd /git
    ln -s /git/ceph-Chinese-doc /git/ceph/doc
  3. 执行 ceph 库内 admin 目录下的 build-doc 开始构建文档;

    cd /git/ceph
    ./admin/build-doc html man
  4. 启动文档服务器,这样就可以通过 http://localhost:8080/ 阅读文档了。

    cd /git/ceph
    ./admin/serve-doc

以上所述就是小编给大家介绍的《Ceph 文档(中文版)》,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对 码农网 的支持!

查看所有标签

猜你喜欢:

本站部分资源来源于网络,本站转载出于传递更多信息之目的,版权归原作者或者来源机构所有,如转载稿涉及版权问题,请联系我们

jQuery

jQuery

Earle Castledine、Craig Sharkie / SitePoint / 2010-02-28 / USD 39.95

jQuery: Novice to Ninja is a compilation of best-practice jQuery solutions to meet the most challenging JavaScript problems. In this question-and-answer book on jQuery, you'll find a cookbook of ready......一起来看看 《jQuery》 这本书的介绍吧!

JS 压缩/解压工具
JS 压缩/解压工具

在线压缩/解压 JS 代码

MD5 加密
MD5 加密

MD5 加密工具