Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Prepare Documents Repository
    1. Login Github and fork https://github.com/hyperledger-labs/fabric-docs-cn
    2. Install git, more details see https://git-scm.com/downloads
    3. Generate SSH key and it to your Github account, more details see https://help.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh
    4. Clone the documents repository to your local use commond “git clone repo-url“, and checkout branch you want to use, like “git checkout -b release-2.0” it will change to branch release-2.0 which is Chinese translation branch.
  2. Claim Tasks
    1. Check the issue list https://github.com/hyperledger-labs/fabric-docs-cn/issues,an issue have five phases now:
      1. untranslated:The document is waiting for translatin
      2. translating:The document is translating by someon
      3. unreviewed:The translation is not reviewe
      4. reviewing:The document is reviewing by someon
      5. completed:The documets is translated and the translation is reviewed ,and the issue will be closed
    2. Add a comment under the issue you want to claim, then wait for assigning by administrator. Like this: Image Added
      1. If the list not contains the document you want to translate, make sure nobody has translated it, and then you can add an new issue,and leave a comment, then wait for assigning
      2. Translate the documents after the administrator assigned it to you
      1. NOTE: If the issue is assigned more than two weeks, but not finished,anybody else can claim the issue again.
  3. Upload Your Translations
    1. Translate the documents with property editor,like Typora, VSCode, Atom, Vim. The source files are in fabric-docs-cn/docs/source directory
    2. Commit and push your translation with signoff. The commonds are like this:
      1. git commit -s -m “your message”
      2. git push
    3. Create a new Pull Reques in repository https://github.com/hyperledger-labs/fabric-docs-cn,you can find it by chose “Pull request – New pull request”, then compare changes and create a PR with a message for want you have done.Like this:Image Added
    4. Waiting for merge by administrator
  4. Check Your Trnaslations
    1. After your PR merged, check the readthedocs (https://hyperledger-fabric.readthedocs.io/zh_CN/release-2.0/ops_guide.html) for your translations, if it is not updated, connect with the administrator

...