Charter
Hyperledger Fabric Japanese Documentation Working Group.
Hyperledger Fabric 日本語ドキュメントのワーキンググループです。
Scope
The purpose of this group is to translate the Hyperledger Fabric documentation to Japanese. This documentation will be synchronized, beginning with the latest LTS version of Hyperledger Fabric (Version 2.2) which is going to be released on July 2020.
このグループの目的は、Hyperledger Fabricドキュメントを日本語へ翻訳することです。ドキュメントは、2020年7月リリース予定のLTS最新バージョンのHyperledger Fabric (Version 2.2)を元に、同期していきます。
Links to Ongoing Work
The original online documentation is: http://hyperledger-fabric.readthedocs.io/
オリジナルのオンラインドキュメントはこちら：http://hyperledger-fabric.readthedocs.io/
The translation Github repository is: https://github.com/hyperledger/fabric-docs-i18n/tree/master/docs/locale/ja_JP
翻訳用Githubリポジトリはこちら：https://github.com/hyperledger/fabric-docs-i18n/tree/master/docs/locale/ja_JP
Ways to contribute
There are many ways you can contribute to the translation, both as a reviewer/translator and a technical supporter.
翻訳への貢献には2つの方法があります。具体的には、レビュア/翻訳者と技術サポートです。このWikiページの下にあるMembersテーブルの右側2列に、希望する役割を記入してください。
（Wikiページの編集は、LinuxFoundationのIDが必要です。どなたでもご自由に登録いただけます。）
1. role：reviewer（査読者）、translator（翻訳者）またはその両方の記入をお願いいたします。
翻訳は基本的にダブルチェックをして、reviewerにマージしていただきます。reviewerは翻訳作業ができないというわけではありません。他のreviewerにチェックをお願いしてください。
なお、ダブルチェックは翻訳品質を保つ目的もありますので、reviewerになる方は、Fabricのご経験やLinuxFoundation発行の資格がある方にお願いしたいと思います。
2. technical support：技術面（githubや翻訳ツールの使い方など）のサポートを引き受けてくださる方はyesを記入ください。
具体的なフォロー内容はまだ決まっていませんが、毎週のミーティング以外で、ツールの使い方のレクチャーをしたり、チャットでフォローをお願いしたりすることを考えています。
Contributing Guideline
Please read the contributing guideline before staring translation. You will find how to make changes and how to use GitHub.
翻訳作業を始める前に、コントリビューションガイドを参照ください。ドキュメントの変更方法やGitHubの使い方を学ぶことができます。
Contributing documentation: https://hyperledger-fabric.readthedocs.io/en/master/CONTRIBUTING.html#contributing-documentation
GitHub Contributions: https://hyperledger-fabric.readthedocs.io/en/master/github/github.html
Project Management
We use GitHub issues and milestone for project management.
githubにファイル/フォルダごとのissueを設定しますので、issueのコメント欄に翻訳着手する旨の申告をお願いいたします。githubのマイルストーンで全体の進捗管理をする予定です。
Target topics
The link below shows documents which should be translated first.
最初に翻訳すべきドキュメントが下記リンクに示されています。ここから優先的に翻訳します。First topics(Introduction, Contribution, Glossary)が翻訳できたら、Read the Docで日本語のページを公開することができます。
https://hyperledger-fabric.readthedocs.io/en/master/international_languages.html#first-topics
Translation Flow
TBD. This slide show a draft.
翻訳フローを現在議論中です。こちらのスライドはドラフトです。
また、zoomミーティングで下記フローを実際に実行しながら確認したときのビデオが2020 08 04 JPDWG Agendaにありますので、ご参考いただければ幸いです。もし、翻訳以外の部分（ツールの使い方、コマンド、インストールなど）でお困りのことがありましたら、Membersテーブルの"technical support : yes"の方または、チャットへお気軽にお問い合わせください。
Translation tools
みんなの自動翻訳 TexTra（このツールの使用は必須ではありません。）
https://mt-auto-minhon-mlt.ucri.jgn-x.jp
翻訳にあたっては、下記の用語、対訳データを参考に翻訳をお願いいたします。
https://github.com/linuxfoundation-jp/HL_Fabric_Doc-Jp
Translation Rules
翻訳の過程で蓄積されていくテクニックや予めルール／方針を統一しておいた方が手間がかからなくて皆が幸せになるような事項を以下にまとめる。
翻訳範囲
| 概要 | 種別 | 説明 | 例(File/Issue/Pull Request) | 備考 | Status (Draft/Approved) |
|---|---|---|---|---|---|
| ヘッダは訳さない | md | ページ内に目次を置く場合、アンカーの都合上、英語のままの方が手間がかからない。 和訳した各ヘッダーにリンク張るためには少しトリッキーな方法が必要だった。 | international_languages.md | ※特に決定事項というわけでもなさそうなので後ほどでご意見お聞かせください（チャットもしくはミーティングで） ※rstも同じかもしれません | A |
| 共通 | |||||
| rst |
日本語文章統一ルール
表記ゆれを防ぐために本WGが定める基本的な日本語文章のルールです。
| 概要 | 備考 | Status (Draft/Approved) |
|---|---|---|
| 語尾は「である」調ではなく「ですます」調を使う | Draft | |
| 句読点は「，」「．」ではなく「、」「。」を使う | Draft | |
Issue/Pull Request発行
| 概要 | 説明 | 例(File/Issue/Pull Request) | Status (Draft/Approved) |
|---|---|---|---|
コミットメッセージおよびPRのタイトルは“[ja_JP]” で始める | ログや一覧で見分けやすいように | [ja_JP] translate glossary.rst into Japanese · hyperledger/fabric-docs-i18n@127a41d | Draft |
PR投稿前のセルフチェックリスト
| 概要 | 説明 | 備考 | Status (Draft/Approved) |
|---|---|---|---|
| Translation Rulesに従っているか | 詳細は上記の「Translation Rules」セクションを参照ください。 | Draft | |
| Hyperledger Fabric固有の単語に関して用語集に従っているか | https://github.com/linuxfoundation-jp/HL_Fabric_Doc-Jp | Draft | |
ドキュメントビルド時(make html)に、 追加のWARNINGメッセージが出ていないことを確認する | 自身の編集作業によって新たに発生したWARNINGはできる限り無くなるように対応してください。 - WARNINGを確認することで、特にrstファイルについて、デッドリンク含めたフォーマットミスはある程度気付くことができます。 - 些細なものもありますが全体数を増やさないことが、他のコントリビュータが自身の追加したWARNINGに気付くのを助け、全体の品質維持につながります。 ※注意事項: 数件のWARNINGは本家から引き継いで発生していますので（後述のWARNING一覧参照）、これらは無視してください。 | Draft | |
ビルド後に、自身が翻訳したページについてブラウザ等で参照し、 フォーマット崩れがないことを一通り確認する |
| Draft | |
1ファイルの翻訳につき1 commitとなっていること | レビューを受けて修正した場合でも、原則的にcommitは1つにまとめる。複数ファイルを翻訳した場合には、ファイルごとに別commitとする。 ただし、同様の修正を複数のファイルにわたって行う場合 (アンカーの修正など) などはこの限りでない。 | Draft | |
本家から引き継いでいるWARNING一覧
release-2.2においては、本家から引き継いで以下のchecking consistency WARNINGが発生しています（2020年8月13日時点）。これらはどこからもリンクが張られていないために発生している警告となります。
日本語翻訳時には、これらは警告については無視してください。
- source/build_network.rst: WARNING: document isn't included in any toctree
- source/developapps/apis.md: WARNING: document isn't included in any toctree
- source/github/github.rst: WARNING: document isn't included in any toctree
- source/ledger.rst: WARNING: document isn't included in any toctree
- source/msp-identity-validity-rules.rst: WARNING: document isn't included in any toctree
- source/policies.rst: WARNING: document isn't included in any toctree
- source/security_model.rst: WARNING: document isn't included in any toctree
- source/tutorial/installxcode.md: WARNING: document isn't included in any toctree
Chatting / Inquiries
We share our activities, workings and inquiries in this chat channel. If you have any questions or problems about the project, please feel free to comment on it in Japanese.
こちらのチャットチャンネルで活動、作業、お問い合わせなどの共有をします。もし、プロジェクトについて何か質問や問題があれば、こちらに遠慮なく日本語でコメントください。
https://chat.hyperledger.org/channel/fabric-docs-japanese
Members
Release Fabric-2.2 Volunteers
Please feel free to provide your name and contact information below.
| Name | Organisation | GitHub handle | Invited | Accepted | role (reviewer, translator) | technical support | |
|---|---|---|---|---|---|---|---|
| Satomi Tsujita | Hyperledger Kansai meetup, co-organizer En-sam-ble K.K. | satomi.t.sora@gmail.com | satomicchy | yes | yes | translator | yes |
Nao Nishijima | Hitachi, Ltd. | nao.nishijima.xt@hitachi.com | naonishijima | yes | yes | ||
| Yuki Kondo | Hitachi, Ltd. | yuki.kondo.ob@hitachi.com | yukiknd | yes | yes | reviewer (contributed to HLF) | |
| Taku Shimosawa | Hitachi America, Ltd. | Taku.Shimosawa@hal.hitachi.com | shimos | yes | yes | reviewer (contributed to HLF) | |
| Tatsuya Sato | Hitachi America, Ltd. | Tatsuya.Sato@hal.hitachi.com | satota2 | yes | yes | reviewer (contributed to HLF) | |
| Hirofumi Fujie | Advanced Integration Technology, Inc. | fujie@ait.co.jp | ait-fujie | yes | yes | translator | |
| Tsubasa Kondou | Advanced Integration Technology, Inc. | kondou@ait.co.jp | T-Kondou | yes | yes | translator | |
| Masashi SALVADOR Mitsuzawa | LayerX, Inc | masashi.salvador.mitsuzawa@layerx.co.jp | MasashiSalvador57f | yes | |||
| Tomoaki Kitaoka | LayerX, Inc | tomoaki.kitaoka@layerx.co.jp | tomo25 | yes | yes | ||
| Naoya Horiguchi | NEC Solution Innovators, Ltd. | naoya.horiguchi@nec.com | Naoya-Horiguchi | yes | yes | reviewer (HLF contributor, CHFA) | yes |
| Masanori Yoshida | Datachain, Inc. | masanori.yoshida@datachain.jp | siburu | yes | yes | translator | |
| Taku Aratsu | IBM Japan, Ltd. | aratsu@jp.ibm.com | aratsu-i | yes | yes | translator | |
| Atsushi Neki | Fujitsu Software Technologies | neki.atsushi@fujitsu.com | nekia | yes | yes | translator | yes |
| Satoshi Nishishita | The Japan Research Insutitute, Ltd. | nishishita.satoshi@jri.co.jp | nishishita-satoshi | yes | yes | translator | |
| Takehiko Amano | IBM Japan, Ltd. | amnt@jp.ibm.com | ibmamnt | Yes | Yes | ||
Yukihiko Hirayanagi | Fujitsu Software Technologies | hirayanagi@fujitsu.com | yukkyhira | yes | yes | translator | |
Takeo Machida | IBM Japan, Ltd | e27258@jp.ibm.com | machidat1 | yes | yes | reviewer translator | |
Shogo Kurimura | IBM Japan, Ltd | e35857@jp.ibm.com | Skurimura | yes | yes | reviewer translator | |
Katsuhiro Kitazume | IBM Japan, Ltd | katsuhiro.kitazume@ibm.com | k-kitazume | yes | yes | translator | |
Yuta Akizuki | IBM Japan, Ltd | Yuta.Akizuki@ibm.com | YutaAkizuki | yes | yes | translator | |
| Akiyoshi Tashiro | NEC Solution Innovators, Ltd. | a_tashiro_29@nec.com | Romeo5929 | yes | translator |