Hugo Docs Japanese

Table of Contents

• About organization
• Translation priority
• Notes
• How to contribute
  • Issue
  • Process
  • Pull request
  • textlint
  • Commit
  • Merge parent branch into child branch
• Netlify deploy preview
• How to contribute after the second
• License

About organization

Hugo Documentation の和訳・日本語翻訳プロジェクトです。以下の Issue で提案しました。

• Translation project for Japanese users · Issue #667 · gohugoio/hugoDocs

実際に Pull Request を出していただくのは以下の Repository です。

• hugojapan/ja

Translation priority

翻訳の優先順位です。

• お好きなページの翻訳をお願いします。
• 一部分の翻訳でも構いません。
• 翻訳の訂正なども歓迎します。

Notes

注意事項です。

翻訳サービスの出力をそのまま利用しないでください。

• ライセンスに引っかかる可能性がある
• まだまだ人間の手直しが必要な品質であることがほとんど
• 参考にする程度で利用してほしい

英文以上の情報を追加しないようにしてください。

• 英文の内容以上の情報を含めるべきと判断した場合は本家に貢献してから
• 良い改善であれば他言語でも共有すべき

翻訳は以下の英語ドキュメントを元に行ってください。

• Hugo Documentation

How to contribute

Issue

まず Issue を見て翻訳の依頼がないかどうか探して、 できそうなものがあればその Issue で「翻訳作業を開始する」というコメントを残してください。

依頼がなければ Issue を作成してどの文書を翻訳するのか宣言してください。 Issue template が用意されているので利用してください。

作業の重複を避けるためにも Issue は良く確認してから参加するなり、新規 Issue を作成するなりしてください。

Process

• hugojapan/ja

を fork した後、以下のような流れで作業することになるはずです。

git clone https://github.com/[your_github_id]/ja.git
cd ja
git remote add upstream https://github.com/hugojapan/ja.git

# node 実行環境が無い方はスキップしても構いません。
npm ci

# 作業用 branch を作ってチェックアウトする。
git checkout -b [target]

# add, commit, push を繰り返す。
vim [target].md
git add [target].md
git commit -m "translate: [target]"
git push origin [target]

Pull request

Draft Pull Request を作成する。 必要があれば適宜追加で add, commit, push する。 準備ができたら Ready for review

textlint

コミットする際に textlint による日本語の校閲が自動で実行されます。 また、個別のファイルに対して npm run lint [target].md で校閲ができます。 textlint のルールについて改善案があれば Issue を出してください。

node 環境が無い場合でも GitHub の方で CircleCI を使って textlint を実行しているので、 リモートで自動的に校閲されます。

CircleCI により実行している textlint でエラーが発生した時は Details をクリックすることで詳細を確認できます。

GitHub pull request	CircleCI job status

Commit

Squash merge するので自分で切ったブランチのコミットは適当で構いませんが、 こまめにコミットすると複数人でレビューしやすいかもしれません。

Merge parent branch into child branch

作業中に master branch で変更があり、それを自分のブランチに取り込みたい場合は 以下のようにして rebase は使わずに merge --no-ff して親ブランチの変更を取り込んでください。

git checkout master
git pull upstream master
git checkout [target]
git merge --no-ff master
# commit
git push origin [target]

Netlify deploy preview

• 世界最速のウェブサイト構築フレームワーク - Hugo

上記リンクは master branch のプレビューです。 Pull request を作成すると Netlify deploy preview のリンクが発行されてプレビューを確認できるようになります。

Netlify deploy preview	Netlify build status

なお、これらのプレビューサイトは robots.txt を設置して検索エンジンによるインデキシングを拒否しています。 よって、このプレビューサイトが検索結果に表示されてしまう心配はありません。 最終的に日本語ドキュメントも gohugo.io のドメインで公開される予定です。

How to contribute after the second

2回目以降の貢献方法です。

cd content/ja

# remote master の変更を local master に取り込む。
git checkout master
git pull upstream master

# 作業用 branch を作ってチェックアウトする。
git checkout -b [target]

# add, commit, push を繰り返す。
vim [target].md
git add [target].md
git commit -m "translate: [target]"
git push origin [target]

Draft pull request を作成して作業を進め、レビューの準備ができたら Ready for review してください。

License

• gohugoio/hugoDocs LICENSE