このプロジェクトでは、翻訳および訳文の修正作業を Transifex 上で行っている。 ただしアプリケーションの開発では普通に行われている Pull Request (以下 PR) に対するビルドは、2018/03/29時点では行ってはいない。 そのため実際に訳文が適用されたドキュメントは、正式な URL (docs.python.org) で公開されてからでないと見られない状況にある。 (手元の環境でビルドする方法もあるが、ビルド環境を用意する必要があり翻訳者に手間を取らせてしまう。)

翻訳の確認の手間を減らすために、訳文の PR を受け付け、 その PR をマージしたドキュメントに対しビルドを行い、PR 公開用の URL から確認してもらう仕組みを構築することとした。 以下はその PR ビルドの仕組みの解説である。

訳文の PR ビルドの機能は次の通り。

• python-docs-ja レポジトリに送られた訳文 PR のビルド
• PR 作成者およびプロジェクト管理者が確認できる場所への、ビルドしたドキュメントの公開、URL の通知
• PR が承認されマージされた後の Transifex への訳文のアップロード
  • この機能は最初は管理者が手動で行い、自動化は後回し
• PR がマージ済みになった後の、PR 確認用ドキュメントの削除
  • この機能は最初は管理者が手動で行い、自動化は後回し

PR ビルドで使用するドキュメントのソースファイルは cpython-doc-catalog にあるものを利用する。

(Travis CI は定期ビルドのために使用済みのため) CI サービスは CircleCI を使用する。

PR ビルドの公開場所は python-doc-ja チームのレポジトリとし、 GitHub Pages の機能を利用する。

TODO: レポジトリを作成したら上の解説に加筆

複数の PR ビルドを同時に公開できるよう、公開場所の URL を設計する。

1. python-docs-ja への PR で PR ビルドが起動
2. CircleCI 環境で、訳文とソースファイルの取得とビルド
3. ビルド結果のドキュメントを公開用の GitHub Pages へアップロード
4. PR ビルドの URL を PR にコメント (当初は手動、将来的に bot で自動化)
5. PR の内容について議論、不備があれば修正し手順1へ戻る
6. PR のマージをきっかけに CircleCI のジョブが起動し Transifex へ訳文をアップロード
   • この機能は最初は管理者が手動で行い、自動化は後回し
7. PR 確認用ドキュメントの削除
   • この機能は最初は管理者が手動で行い、自動化は後回し