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

garbagetown

個人の日記です

ドキュメント翻訳の手順

この記事は Play framework Advent Calendar 2014 - Adventar の三日目です。

四日目の立候補者がいないので誰か書いてください。

おまえ誰

2010 年 4 月から Play Framework のドキュメントを翻訳しています。

以前は http://www.playframework-ja.org/ に Play 1.2 で書いたアプリをデプロイして翻訳ドキュメントを公開していましたが、現在は https://www.playframework.com/documentation/ja/ で公開しています。

が、まったく手が足りていないので、この場を借りてドキュメント翻訳の具体的な手順を紹介することで、ひとりでも多くの人に手伝ってもらえたらいいなと思っています。

概要

Play Framework 2.x のドキュメントは Markdown 記法 で書かれており、 GitHub で管理されています。

翻訳版も GitHub で管理しており、こちらの例 のように、原文をコメントアウトして翻訳文を併記しています。

ちなみに Play Framework 1.x のドキュメントは textile 記法 で書かれていますが、こちらはコメントアウトができないので、こちらの例 のように翻訳文だけ書いていました。

playframework.com は翻訳版の GitHub リポジトリを定期的にポーリングしていて、翻訳版リポジトリに取り込まれた内容は、すぐに playframework.com に反映されます。

ドキュメント翻訳の手順

おおまかな手順は 翻訳ガイドライン に書いてあるので、まずはこちらを参照してください。

以下、もっとも簡単なパターンの手順を紹介します。

例えば 2.3.x/JavaActionsComposition に未翻訳箇所を発見したとします。 f:id:garbagetown:20141204010410p:plain

ページフッタにあるドキュメントソースへのリンクをクリックします。 f:id:garbagetown:20141204010449p:plain

GitHub のページが開くので、ログインします。 f:id:garbagetown:20141204010857p:plain

翻訳する前に他の誰かが作業着手していないことを確認してください。ファイル名などで issues を検索します。 f:id:garbagetown:20141204011139p:plain

コメント欄に作業着手する旨が書かれていなければ、自分が作業する旨をコメントしてください。内容はなんでも構いません。 f:id:garbagetown:20141204011412p:plain

いよいよ翻訳します。ここでは GitHub 上のエディタで作業します。ドキュメントソースのページに戻り、編集ボタンをクリックします。 f:id:garbagetown:20141204011532p:plain

編集が完了したら、コミットコメントに issues の番号を入力して Propose file change ボタンをクリックします。 f:id:garbagetown:20141204011733p:plain

自動的にリポジトリが fork され、Pull Request の作成画面が表示されるので、Create pull request ボタンをクリックします。基本的な作業はこれで終わりです。 f:id:garbagetown:20141204011852p:plain

最後に、playframwork-ja グループのメンバーが Pull Request の内容をレビューし、問題なければマージします。 f:id:garbagetown:20141204012025p:plain

マージが完了したら、10 分以内に playframework.com に変更が反映されます。 f:id:garbagetown:20141204012155p:plain

まとめ

ちょっとした翻訳や修正の場合、GitHub のアカウントさえあれば、どなたでも簡単にご協力頂けることがお分かり頂けましたでしょうか。

Play Framework 2.3.x の翻訳は、まだまだ issues が残って います。どうぞお気軽にご協力ください。

あと、四日目のアドベントカレンダーを誰か書いてください。以上です。