Creating a new translation

対象読者: 新しくFabricの翻訳を作成したい方

Hyperledger Fabricのドキュメントに、あなたのほしい言語がなかったら、ぜひ新しい翻訳を始めてみましょう! これは比較的簡単に始められますし、新しく翻訳を始めることは、あなたにとっても他のFabricユーザーにとっても、 とても満足いく活動となりうるはずです。

このトピックでは、以下について説明します。

Introduction

Hyperledger Fabricのドキュメントは、多くの異なる言語に翻訳されつつあります。例えば、

もし、あなたの求める言語が存在しない場合には、まず最初に新しい言語ワーキンググループを作成しましょう。

Create a new workgroup

他の翻訳者と協力することで、翻訳、メンテナンス、その言語のレポジトリの管理がより簡単になります。 このためには、既存のワーキングループのページを参考にして、まず新しいワーキンググループを 国際ワーキンググループのリスト に追加します。

ここには、ワーキンググループがどのように共同作業をしていくかを記述してください。ミーティング、チャット、 メーリングリストなどは、すべてとても有用でしょう。ワーキンググループのページで、 これらの共同作業の方法について明確にしておくことは、翻訳者のコミュニティを形成するのに役立つでしょう。

そして、Rocket.Chatのチャネルを使って、 他の皆さんに翻訳を始めたことをお知らせし、ワーキンググループへの参加を募集しましょう。

Create a new translation

新しい言語のレポジトリを作成するにあたっては、下記の手順を守りましょう。ここでは、メキシコで使われているスペイン語への 翻訳を例にとって、新しい言語への翻訳を開始する手順を説明します。

  1. fabric-docs-i18n レポジトリ を、あなたのGitHubアカウントにフォークします。

  2. ローカルマシンにフォークしたレポジトリをcloneします。

    git clone git@github.com:(あなたのGitHub ID)/fabric-docs-i18n.git
    
  3. ベースにするFabricのバージョンを選びます。Fabric 2.2がLTSリリースなので、まずはこれを使うことを お勧めします。他のバージョンは後で追加することができます。

    cd fabric-docs-i18n
    git fetch origin
    git checkout release-2.2
    
  4. ローカルにフィーチャーブランチを作成します。

    git checkout -b newtranslation
    
  5. 適切な 2文字か4文字の言語コード を選択します。メキシコのスペイン語は、 es_MX です。

  6. レポジトリのルートにある CODEOWNERS ファイル を編集します。次の行を追加します。

    /docs/locale/ex_EX/ @hyperledger/fabric-core-doc-maintainers @hyperledger/fabric-es_MX-doc-maintainers
    
  7. 新しい言語用のフォルダを docs/locale/ 以下に作成します。

    cd docs/locale
    mkdir es_MX
    
  8. 他の言語フォルダから、ファイルをコピーします。例えば、

    cp -R pt_BR/ es_MX/
    

    もしくは、fabric レポジトリの docs/ フォルダからコピーしてもかまいません。

  9. 新しい言語用に、この例 を参考に README.md を編集します。

  10. 変更した内容を、ローカルにコミットします。

    git add .
    git commit -s -m "First commit for Mexican Spanish"
    
  11. ローカルの newtranslation ブランチを、フォークした fabric-docs-i18n レポジトリの release-2.2 ブランチに対してpushします。

    git push origin release-2.2:newtranslation
    
    
    Total 0 (delta 0), reused 0 (delta 0)
    remote:
    remote: Create a pull request for 'newtranslation' on GitHub by visiting:
    remote:      https://github.com/(あなたのGitHub ID)/fabric-docs-i18n/pull/new/newtranslation
    remote:
    To github.com:(あなたのGitHub ID)/fabric-docs-i18n.git
    * [new branch]      release-2.2 -> newtranslation
    
  12. フォークしたレポジトリとReadTheDocsを この手順 にしたがって連携させます。 ドキュメントが正しくビルドされることを確認します。

  13. newtranslationのプルリクエスト(PR)を、GitHubの下記のURLから作成します。

    https://github.com/(あなたのGitHub ID)/fabric-docs-i18n/pull/new/newtranslation

    PRは、ドキュメントメンテナ の誰かによって承認される必要があります。 PRがあると自動的にメンテナにe-mailで通知されますが、Rocket.Chat経由でコンタクトをとってもかまいません。

  14. Rocket.Chatの i18n チャネル で、 新しい言語のメンテナのグループである @hyperledger/fabric-es_MX-doc-maintainers の作成を依頼します。グループに登録するため、あなたのGitHub IDも伝えてください。

    このリストに追加されると、他の翻訳者をワーキンググループに自分で追加することができるようになります。

    もしissueを誰かに割り当てたい場合には、コラボレータに追加するように依頼してください。その翻訳者は、コアレポジトリメンテナに Hyperledger Github Organization に追加してもらって、コミュニティのメンバーである必要があるからです。

おめでとうございます! これで、新しい言語の翻訳者のコミュニティが、 fabric-docs-i18n レポジトリで 翻訳を行えるようになります。

First topics

新しい言語が、ドキュメントのWebサイトに掲載されるためには、下記のトピックについて翻訳を行う必要があります。 その言語の利用者や翻訳者が新たに参加するために、これらのトピックが役立つでしょう。

  • Fabric front page

    ここがあなたの看板となるでしょう! あなたのおかげで、利用者は、その言語のドキュメントがあることを 知ることができます。完全ではないかもしれませんが、少なくとも、あなたとそのチームが何を達成しようと しているかは明確になります。このトピックを翻訳することで、他の翻訳者を勧誘するのにも役立つでしょう。

  • Introduction

    この短いトピックは、Fabricのハイレベルの概要について述べています。新しいユーザーは、おそらくこのトピックを 最初に見るでしょうから、これが翻訳されているということは重要でしょう。

  • Contributions Welcome!

    このトピックは非常に重要です。コントリビューターは、Fabricに対する貢献の方法について、 なぜ どうやって を理解することができるからです。翻訳で共同作業を行うためにも、このトピックを翻訳する必要があります。

  • Glossary

    このトピックの翻訳は、ほかの翻訳者が作業を進めるうえで必須のリファレンスとなります。いいかえると、 このトピックの翻訳によって、ワーキンググループをスケールさせることができます。

これらのトピックの翻訳が終わり、新しい言語のワーキンググループができれば、あなたの翻訳をドキュメントの Webサイトに掲載することができます。 例えば、中国語(簡体字)の翻訳は、 ここ にあります。

Rocket.Chatの i18n チャネル で、 あなたの翻訳をWebサイトに追加するように依頼できます。

Translation tools

アメリカ英語からあなたの言語に翻訳を行う際に、最初のパスでオンラインツールを利用し、 二回目のパスでそれを修正するというのが、便利なことが多いです。

各ワーキンググループでは、下記のようなツールを有用だとしています。

Suggested next topics

必須のトピックがドキュメントのWebサイトに掲載されたら、下記の順に翻訳を進めるのがよいでしょう。 他の順番で行うことにしてもかまいませんが、その場合でも、ワーキンググループで、翻訳の順番について合意しておくとよいでしょう。

  • Key concepts

    ソリューション・アーキテクト、アプリケーション・アーキテクト、システム・アーキテクト、開発者、 研究者、学生など向けに、Fabricのコンセプトを包括的に説明しています。

  • Getting started

    Fabricのハンズオンが必要な開発者向けに、インストール・サンプルネットワークの構築・Fabricで 手を動かすための主要な手順について説明しています。

  • Developing applications

    開発者向けに、Fabricを使ったどんなソリューションでもコア要素となる、スマートコントラクトと アプリケーションの書き方を説明しています。

  • Tutorials

    開発者と管理者向けに、Fabricの特定の機能について試すためのハンズオン・チュートリアルを 集めたものです。

  • What's new in Hyperledger Fabric v2.x

    Hyperledger Fabricの最新の機能について説明しています。

最後に、あなたの健闘を祈るとともに、Hyperledger Fabricへの貢献に感謝します。