...
PR 被 merge 之后请去中文文档查看翻译内容是否已更新,如果没有更新请联系管理员。
Fabric Documents Translate Workflow
- Prepare Documents Repository
- Login Github and fork https://github.com/hyperledger-labs/fabric-docs-cn
- Install git, more details see https://git-scm.com/downloads
- 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
- 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.
- Claim Tasks
- Check the issue list https://github.com/hyperledger-labs/fabric-docs-cn/issues,an issue have five phases now:
- untranslated:The document is waiting for translatin
- translating:The document is translating by someon
- unreviewed:The translation is not reviewe
- reviewing:The document is reviewing by someon
- completed:The documets is translated and the translation is reviewed ,and the issue will be closed
- Check the issue list https://github.com/hyperledger-labs/fabric-docs-cn/issues,an issue have five phases now:
- Add a comment under the issue you want to claim, then wait for assigning by administrator. Like this:
- 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
- Translate the documents after the administrator assigned it to you
NOTE: If the issue is assigned more than two weeks, but not finished,anybody else can claim the issue again.
- Upload Your Translations
- Translate the documents with property editor,like Typora, VSCode, Atom, Vim. The source files are in fabric-docs-cn/docs/source directory
- Commit and push your translation with signoff. The commonds are like this:
- git commit -s -m “your message”
- git push
- 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:
- Waiting for merge by administrator
- Check Your Trnaslations
- 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