kumofsドキュメント計画

9 views
Skip to first unread message

FURUHASHI Sadayuki

unread,
May 26, 2010, 11:01:25 AM5/26/10
to kumo...@googlegroups.com
古橋です。

kumofsの英語のドキュメントを整備する計画をスタートしました。
新しいドキュメント: http://kumofs.sourceforge.net/doc/

日本語の情報は、ブログ記事を含めるとそこそこあるのですが、英語の情報が
まったく不足しています。このままではもったいないので、ぜひ英語の情報も充
実させていきたいと思っています。

そこで、もし手を貸していただける方がいらっしゃれば、ドキュメントの充実に
ご助力いただきたいと思っています。
特に日本語のドキュメント
(http://github.com/etolabo/kumofs/blob/master/doc/doc.ja.md) や、プレゼ
ンテーション資料の英訳を手伝っていただけると、とても嬉しいです。

ドキュメントはgithubで管理しており、commitするとウェブサイトに自動的に反
映される仕組みになっています。githubのアカウントがあれば、リポジトリを簡
単にforkして編集することができます。

リポジトリのURL: http://github.com/frsyuki/kumofs-doc

章立ては、日本語のドキュメントとほぼ対応するようになっています。

編集の手順は次の通りです:

1. githubのリポジトリを自分のリポジトリにforkする(Forkボタンを押す)
forkのしかた: http://help.github.com/forking/
リポジトリのURL: http://github.com/frsyuki/kumofs-doc

2. forkした自分のリポジトリをcloneして、編集する
$ git clone g...@github.com:YOURNAME/kumofs-doc.git

1. 新しく追加するには、とりあえずfaq.rstファイルに書いてください
2. 大きくなってきたら、howto.rstファイルに移してください
3. 分類できそうになったら分類してください

3. pull request を送ってください(Pull Requestボタンを押す)


ドキュメントの生成には、Sphinxを使っています。
SphinxのURL: http://sphinx.pocoo.org/

Sphinxをインストールするには、easy_installを使ってください:
$ easy_install -U Sphinx

--
古橋貞之
筑波大学 システム情報工学研究科
http://d.hatena.ne.jp/viver/
http://frsyuki.wordpress.com/

Reply all
Reply to author
Forward
0 new messages