PHPマニュアルの日本語版をビルドするためのDockerイメージを公開しました。

このイメージを使うと、手間のかかる設定をせずに、PHPマニュアルの日本語翻訳が始められます。

翻訳の始め方

まずはオンラインエディタにログインし、翻訳対象ファイルを決め、翻訳を進めていきます。このあたりは以前Qiitaに書いた「PHPマニュアル日本語版にパッチを送る」が参考になるかと思います。

いい感じに翻訳できたら、表示を確認するため、Dockerコンテナ上でファイルを編集し、マニュアルをビルドしてみましょう。たとえば、ja/language/predefined/error/getcode.xml を編集する場合は下記のような手順になります。

# Dockerイメージを取得
docker pull iwamot/phd-ja

# コンテナを起動
docker run -it -p 8080:80 --name phd-ja iwamot/phd-ja

# 最新のソースを取得
docker exec phd-ja ../scripts/phd-update

# コンテナのbashに入る
docker exec -it phd-ja bash

# ファイルを編集し、コンテナから抜ける
vi ja/language/predefined/error/getcode.xml
exit

# マニュアルをビルド
docker exec phd-ja ../scripts/phd-build

編集内容は http://localhost:8080/phd-ja/error.getcode.html で確認できます。違和感がなければオンラインエディタに戻り、パッチを送ってみましょう。


追記(2018-06-27)

この記事を公開後、改善を進めて、ファイルの編集やビルドがブラウザ上でできるようになっています。詳細は下記の記事をご参照ください。


イメージを公開した理由

PHPマニュアルのビルド環境を作るのには手間がかかります。PHP5環境の準備、Subversionリポジトリのチェックアウト、PhDのインストール、HTTPサーバの設定などが必要なためです。この手間を省ければ、翻訳への参加者が増えるかもしれないと考えました。

日本語への翻訳率は63%と比較的高いのですが、それでも現時点で4000ファイル以上が未翻訳、700ファイル以上が古くなっている状況です。翻訳率を高めるには、参加者を増やすのが効果的だと思っています。

改善案などの連絡手段

「Dockerfileのベストプラクティスはこうだよ」とか「テストがないけど、こんなふうに書いたらいいんじゃない?」とか「素のデザインだと見づらいのでCSSを書いてみたよ」とか、何かしらお気づきの点がありましたら、GitHubのプルリクエストやissue、Twitterなどでお知らせいただければ幸いです。

ぼくはこれまでサーバ上に直接、ビルド環境を作っていましたが、今後はこのDockerコンテナで作業します。不便を感じたら、随時改善して公開イメージに反映していきます。