HAYASHI Kentaro
null+****@clear*****
Mon Jul 22 18:37:30 JST 2013
HAYASHI Kentaro 2013-07-22 18:37:30 +0900 (Mon, 22 Jul 2013) New Revision: 957916df9634386f730e8d0ff9a7de8955a891e6 https://github.com/groonga/groonga.org/commit/957916df9634386f730e8d0ff9a7de8955a891e6 Message: blog ja: add topics which are cited from past release announcement Added files: ja/_posts/2013-07-22-api-documentation.textile ja/_posts/2013-07-22-qiita-translation.textile Added: ja/_posts/2013-07-22-api-documentation.textile (+70 -0) 100644 =================================================================== --- /dev/null +++ ja/_posts/2013-07-22-api-documentation.textile 2013-07-22 18:37:30 +0900 (dad82e8) @@ -0,0 +1,70 @@ +--- +layout: post.ja +title: APIドキュメント化始めました +description: APIドキュメント化始めました +--- + +h2. APIドキュメント化始めました + +長い間懸案であった、groongaのAPIをドキュメント化する作業を始めました。 + +始めた理由は二つあります。 + +一つはAPIのドキュメントがないので、groongaをライブラリとして使おうとしたときにはソースを直接参照しないといけないためです。 + +もう一つの理由は、Visual Studioでビルドするときに大量の警告メッセージが出力されるのを解消したい、というのがあります。現在mroongaをMariaDBにバンドルできるようにする作業を進めているのですが、この状態でバンドルしてもらうのは難しいです。groongaのヘッダに日本語で説明を書いているせいなので、ヘッダから日本語を追い出すことで問題を解消したいなぁというのがあります。 + +上記からドキュメント化の作業を始めたわけですが、現状リソースがまったく足りていません。 + +そこで、ユーザのみなさんにも協力していただけたらいいなと思っています。MariaDBへのバンドルを応援したいという人はドキュメント化作業に参加してくれると嬉しいです。 + +では具体的にどんなことをやればいいのかを説明します。基本的には関数ごとにpull requestを送ってもらうと進めやすいです。 + +1. groongaとgroonga.orgのリポジトリをcloneして以下のコマンドを実行します。 + +<pre> +% git clone git://github.com/groonga/groonga.git +% git clone git://github.com/groonga/groonga.org.git +% cd groonga +% ./autogen.sh +% ./configure --enable-document --with-groonga-org-path=(groonga.orgをcloneしたパス) +</pre> + +2. include/groonga.hを眺めて日本語のコメントがついている関数を一つ探します。例:grn_ctx_open + +3. 関数が見つかったら、関数に対応するブランチをつくります。 + +<pre> +% git checkout -b grn-ctx-open +</pre> + +4. 関数のコメントの内容をdoc/source/reference/api/grn_ctx.txtに移動します。移動するときに英訳とマークアップを行います。grn_ctx.txtにはすでにgtn_ctx_initの例があるのでそれを真似して下さい。 + +5. groonga.hからはコメントを削除します。 + +6. 対象となるファイルを更新するために以下を実行します。 + +<pre> +% make update-files +</pre> + +7. メッセージカタログを更新するために以下を実行します。 + +<pre> +% make update-po +</pre> + +8. ドキュメントを生成するために以下を実行します。 + +<pre> +% make update-document +</pre> + +9. ドキュメントの生成結果を見て翻訳されていない部分を修正します。doc/locale/ja/LC_MESSAGES/po以下のメッセージカタログのmsgstrを修正することになります。 + +10. 英語のドキュメントと日本語のドキュメントがきちんと生成できたらコミットしておきます。 + +11. 完成です。pull requestを送りましょう。 + +HTMLの結果を確認するにはdoc/locale/en/htmlもしくはdoc/locale/ja/html以下を参照してください。 + Added: ja/_posts/2013-07-22-qiita-translation.textile (+33 -0) 100644 =================================================================== --- /dev/null +++ ja/_posts/2013-07-22-qiita-translation.textile 2013-07-22 18:37:30 +0900 (12eefe8) @@ -0,0 +1,33 @@ +--- +layout: post.ja +title: 週刊groonga翻訳始めました +description: 週刊groonga翻訳始めました +--- + +h2. 週刊groonga翻訳始めました + +毎週木曜に "Qiita":http://qiita.com/ にてgroongaやmroonga,rroongaなどのトピックを一つ投稿するという取り組みを続けています。 + +それなりにトピックがたまってきたので、これを翻訳して英語圏にも情報を発信していこうかと考えています。 + +ただ、現状リソースがあまり足りていないので、ユーザのみなさんにも協力していただけたらいいなと思っています。 + +具体的には以下のようにして作業をすすめていきたいと思います。 + +1. Qiitaに英語圏向けのノウハウ・Tipsの投稿ページを元記事を複製して用意する (この時点では内容は日本語のまま) + +2. 記事ページをみんなでよってたかって翻訳する このときには「 "編集リクエスト":http://blog.qiita.com/post/40808687185/patch-request-release 」を使って記事を更新します。 + + +3. 記事の翻訳が完成したら、内容に応じて "blogroonga":http://groonga.org/blog/ や "mroonga blog":http://mroonga.org/blog/ に掲載します。 + +4. Tumblrでリブログ + +1,3,4はgroonga開発チームでやるとして、2.のところを手分けして実現できたらいいなぁと思っています。 + +まずは、「 "groongaでキーワードごとに重み付けをして検索するには":http://qiita.com/groonga/items/a964be5d754a52f00512 」の翻訳からはじめていきます。作業対象の投稿は以下の通りです。 + +* "How to search specific keyword with assgined weights to each column":http://qiita.com/groonga/items/43a4cc07512c63193a07 + + + -------------- next part -------------- HTML����������������������������...Download