ellis-wu / ceph-doc-taiwan

Ceph documentation for taiwan

Ceph 中文翻譯

本翻譯主要是從drunkard/ceph-Chinese-doc進行繁體中文翻譯，並針對新版本做更新與修正，未翻譯部分也會漸漸完成。

參與貢獻

1. 在 Github 上 fork 到自己的 Repository，例如：<User>/ceph-doc-taiwan.git，然後 clone到 local 端，並設定 Git 使用者資訊。

git clone https://github.com/kairen/ceph-doc-taiwan.git
cd ceph-doc-taiwan
git config user.name "User"
git config user.email [email protected]

2. 修改程式碼或頁面後，透過 commit 來提交到自己的 Repository：

git commit -am "Fix issue #1: change helo to hello"
git push

若新增採用一般文字訊息，如Add ceph block device intro...。

3. 在 GitHub 上提交一個 Pull Request。
4. 持續的針對 Project Repository 進行更新內容：

git remote add upstream  https://github.com/kairen/ceph-doc-taiwan.git
git fetch upstream
git checkout master
git rebase upstream/master
git push -f origin master

編譯

Java 虛擬機應該用 oracle-jdk-bin-1.8 或 ```oracle-jdk-bin-1.7`` ，使用 jre 會缺少必要的lib檔案。

問題

• 編譯系統是基於 python2，不支援python3，會有語法錯誤問題，在Gentoo/Funtoo 下如果環境錯誤，可以用以下方式臨時切換到 python2.7：

eselect python set python2.7
ln -sf /usr/bin/python2.7 /usr/bin/python

• ditaa 圖片無法翻譯為中文，因為渲染時的字體問題還沒有解決。

編譯步驟

目前已經將 Ceph 專案的 Build 工具移至本 git，可以使用以下指令進行編譯：

• 執行 admin 目錄底下的build-doc開始建立 html 檔案。

admin/build-doc

當編譯完成，就會產生一個輸出目錄build-doc/output，將輸出檔案拷貝到 HTTP Server 就可以了。

• 執行serve-doc，就可以透過 HTTP 方式閱讀文件了。

admin/serve-doc

文件編寫風格

要盡量遵守原文件的書寫風格，如縮排、不超過 80 寬高等。有些風格是中文版特有的，諸如：

• 中文和非中文用空格分隔
• 插入指令，前一段行尾加空格和雙引號（ ' ::' ）
• 引用和正文間加""，這樣不影響編譯系統又不會額外增加空格
• 用反斜線""換行，這樣不會額外增加空格
• 原文中用雙引號引用的詞語在中文文件裡可去掉引號，因為原文引用它已經很顯眼了
• 由於字體和程式的問題，在"Ternimal"下能更好地對齊到 80 列

更新方式

UPDATE 文件內容是doc/目錄下的最新commit，說明本次更新到了這裡。之後的更新可以對照原文和doc/目錄下的commit歷史，不用一個一個對照的繁瑣。

獲取此 commit ID 的指令為：

git log -1 --pretty=oneline doc/ | cut -d ' ' -f 1

查看doc/目錄自上次更新以來的變更：

CEPH_REPO=/git/ceph
ID=`cat UPDATETO` && cd $CEPH_REPO && gitview ${ID}.. doc/ &