Japanese version of guide.elm-lang.org
Branch: master
Clone or download
ElmDocCI
Latest commit 9bf0563 Feb 5, 2019

README.md

Japanese translation of guide.elm-lang.org

Original version

guide.elm-lang.org 日本語化プロジェクト

たまに大元のプロジェクトの変更をマージします。

進捗

robots.txt でコメントアウトされているページはまだ翻訳が公開されていません。 robots.txt で検索エンジンによるクロールを禁止することで、コピーコンテンツと見なされて順位が低下するのを防いでいます。

翻訳に貢献する

え? 貢献してくれるんですか?! It's super helpful!

レビュアーとして貢献する

他の方が翻訳した内容をレビューしていただける方も大募集です! ご都合の良いときにマージ前のプルリクに対して「もしかしたらここはこうしたらもっとわかりやすくなるかも!」みたいなコメントをつけていただくだけです。 翻訳作業もレビュアーとしての参加もとてもとてもありがたいです!

翻訳のやり方

./book 以下のファイルの英語の原文をコメントアウトして、その下に日本語を記入していきます。 サンプル

$ npx pretranslate ./book/your_file_to_translate

を実行することで、自動的に対象ファイルをパラグラフごとにコメントアウトし、さらに ./book/about_translation.md の対訳表にしたがって文中に出てくる用語の標準的な対訳を付記してくれます。

対訳表自体は手動で更新が必要です。重要そうな単語を訳した際に都度対訳表に追加してください。

翻訳の方針

翻訳の方針については翻訳についてを事前にご確認ください。

翻訳しようと決めたら

せっかく翻訳していただいたのに、実は同時に他の人が同じところを翻訳していて先にPRを出されちゃったらすごくもったいないですよね? それを防ぐためにまず対応する issue を探して「これを担当します」とコメントするか、権限がある方は自分を assign してください。 他の人が「お、これは作業中だな」と気づくのでオススメです!

また、こちらは任意ですが

$ git checkout -b ${your_branch_name}
$ git commit --allow-empty -m 'Empty commit'
$ git push origin ${your_branch_name}

のように空のコミットでブランチをプッシュして、「[WIP] interop/flags.md」 みたいなタイトルのPRを作っても良いでしょう。

ローカル環境で確認する

まず下記のコマンドで依存するプログラムをインストールします。

$ npm i
$ npm run install

下記のコマンドで開発サーバーが立ち上がります。

$ npm start
...
...
Starting server ...
Serving book on http://localhost:4000

http://localhost:4000 にアクセスすることで表示の確認ができます。

本番環境へのデプロイ

いまはCIが自動でやっていますが、念のため記載しておきます。

$ git checkout master
$ npm run build
$ git add docs && git commit -m 'Update docs' && git push origin master