reboot

翻訳作業を再開するに当たり現時点 (2016/02/04) の状況をメモ。

リポジトリ

• playframework-ja/translation-project: Play Framework Documentation Japanese Translation

仕組み

playframework.com が 10 分ごとに上記リポジトリをポーリングしていて、以下のルールに該当する tag または branch を更新すると自動的に playframework.com に反映される。

• tag
  • 数字とピリオドのみで構成された名前
  • 2.4.4 など
• branch
  • 数字とピリオドで始まり、数字または x で終わる名前
  • 2.4.4 や 2.4.x など
  • issues_xxx のようなプルリクエストブランチは取り込まれない

tag はフレームワーク本体のリリースに併せて公開され、更新されない。branch はフレームワークのマイナーバージョンが変わらない限り更新され続ける。このため、tag はひたすら翻訳すればよいが、branch は本家の更新を検知して反映していく仕組みが必要。

playframework.com はリクエストの Accept-Language ヘッダを見て表示すべきドキュメントを判断している。このため、日本語が設定されたブラウザでアクセスすると古い日本語版ドキュメントが優先して表示されてしまい、初心者は最新のフレームワーク本体と古いドキュメントの差異にハマる可能性がある。

その他、本家にも翻訳に関するドキュメントがある。

• Translations

体裁とか進め方

過去に下記にまとめたが、意識が高過ぎて協力者のみなさんが引いた反省があり、これからはもっとゆるくやりたい。

• translation-project/CONTRIBUTING.md at 2.3.x · playframework-ja/translation-project

あとブログも書いた。

• ドキュメント翻訳の手順 - garbagetown
• ドキュメント翻訳の裏側 - garbagetown

現状

• 本家
  • フレームワーク本体は 2.4.6 が最新
  • ドキュメントは 2.4.4 までタグが切られ、2.4.x が日々更新されている
• 翻訳
  • 2.2.0 まで完成
  • 2.2.5, 2.2.x, 2.3.x の branch が併走している
  • 2.2.5, 2.3.5 向けの大量の issue が放置されている
    • https://github.com/playframework-ja/translation-project/issues?q=is%3Aopen+is%3Aissue+milestone%3A2.2.5
    • https://github.com/playframework-ja/translation-project/issues?q=is%3Aopen+is%3Aissue+milestone%3A2.3.5

今後の方針

2.2.x, 2.3.x は中断して、2.4.x に取り組むべきだと思う。

• 2.4 で DI の仕組みが入り、多くのユーザが移行しているっぽい
  • 2.2.x, 2.3.x のドキュメントを参照するユーザは少ないはず
• 2.5 で Akka Stream ベースになり激変する見込み
  • スムーズに移行が進むか不明瞭

git リポジトリをどのように管理すべきか考え中。

• 2.2.0 branch に戻して 2.4.4 を上書きして未翻訳のまま 2.4.4 branch を切る
  • 以前は fix version の tag がないと x.x.x branch が取り込まれない仕様だったが、2.3.x が取り込まれているので変更されたっぽい
• 2.4.4 branch に 2.4.x を上書きして未翻訳のまま 2.4.x branch を切る
• 2.4.x branch で翻訳を進める
• 翻訳が完了したドキュメントから差分を確認しつつ下記 branch にマージする
  • 2.4.4
  • 大きな差分がないようであれば 2.2.x, 2.3.x

課題

• 本家に追従する仕組み
• バージョンアップ時に差分のみ翻訳する仕組み
• 参考
  • Social Translating: Rails チュートリアルを支える継続的翻訳システム // Speaker Deck

さくら VPS あたりを借りてなんらかの仕組みを構築したい気持ちはある。