読者です 読者をやめる 読者になる 読者になる

ひとりでやるRiak Advent Calendar 2012 day23 - ドキュメンチョ

Documents

Riak関連のドキュメントは全部 docs.basho.com (日本語訳)に集約されているが、もしもあなたがそのドキュメントに間違いを見つけたとしよう。みなさん必ず報告してくれるはずだ。そういうときはどこに報告したらよいだろうか。 basho.co.jp のサイトからでもよいし、Twitter経由でもよいが*1。よいのだが。
せっかくだからみんなドキュメントを修正しよう。レポジトリbasho/basho_docs にある。basho.co.jp と同じレポジトリだ。ここにIssueを切るなどという面倒なことをせずにPull-Requestを送ればよいのだ。そのためにはドキュメントをローカルでビルドしてみる必要があるよね。この際だから飛行機の中からRiak関連のドキュメント読みたいよね。そういうときのための手順を書いておこう。bundlerが入っていてほしい。

$ git clone git://github.com/basho/basho_docs
$ cd basho_docs
$ bundle install --path=somewhere/other/than/roots
...
Installing versionomy (0.4.4) 
Installing watchr (0.7) 
Your bundle is complete! It was installed into ./vendor/bundler
$ bundle exec middleman
== The Middleman is loading
RIAK_DOCS_LANG=en
RIAKEE_VERSION=1.3.0
RIAKCS_VERSION=1.2.1
RIAK_VERSION=1.3.0
JAVA_VERSION=1.1.0
== Generating Dual Pages
== Locales: en
== The Middleman is standing watch on port 4567

これで http://localhost:4567 を開くと多分 docs.basho.com と同じページが見れているはず。middlemanはスグレモノなのでファイルを編集すると自動的にロードしてくれます。ブラウザはリロードしてくれないけど…さあこれでもう編集はできたよね!
ちなみにIssueをPRに変更するのにはhubってやつが便利です

Gemfileに

source :rubygems

がまだ入っているのはご愛嬌。

*1:@kuenishiに来てもいいけど、困るんだよなァ…