MRTK ドキュメントの日本語翻訳

作業フロー

• 翻訳の対象ファイル
  • MixedRealityToolkit-Unity/Documentation.ja 配下の *.md
• 翻訳作業用ブランチ
  • 大本のブランチ ： feature/mrtk_documentation_jp
• 上記ブランチから作業用として doc_ja/作業対象.md のブランチを切り翻訳作業をする
• 翻訳したらfeature/mrtk_documentation_jpにプルリクエストを送る
• 作業途中で、誰かに見てもらいたい場合は、タイトルに[WIP] をつけて Pull Request を送る
  • [WIP] がついているものはマージしてはいけない
  • 作業が完了したらタイトルの [WIP] を外す

レビューとマージ

• 最低1人がレビューを行ってください。
• レビュー時は、「Insert a suggestion」機能を活用してください。レビューされた側が1ボタンで変更を反映できます。
• レビューでの指摘箇所が反映され、レビューが完了したら approve 状態にしてください。
• マージは @tarukosu が行います ​

翻訳ガイドライン

翻訳ガイド ページにまとめました。

DocFx

• docfx でのドキュメント生成の自動化をしているので feature/mrtk_documentation_ja ブランチが更新されたら、以下のページが更新される
  https://hololabinc.github.io/MixedRealityToolkit-Unity/README.html ​

DocFx インストール

• docfx のインストールは chocolatey を入れて、choco install docfx -y をするのが簡単（windows) ​ https://chocolatey.org/install ​ https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html#2-use-docfx-as-a-command-line-tool ​

> docfx docfx.json --serve

を実行すると、http://localhost:8080 で手元でドキュメントページをみることができる ​

Other

• 元の英語ドキュメントにおかしなところを見つけたら、本家に Pull Request 送る
• 不安な場合は、社内slackの #技術_mrtk で相談