Skip to content

Commit

Permalink
Advice for translators, PRs and tools
Browse files Browse the repository at this point in the history
Signed-off-by: Anthony O'Dowd <a_o-dowd@uk.ibm.com>
(cherry picked from commit 709d3d7)
  • Loading branch information
ODOWDAIBM authored and lindluni committed Jul 10, 2020
1 parent 5dc22d5 commit dd556f3
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 2 deletions.
11 changes: 10 additions & 1 deletion docs/source/docs_guide.md
Expand Up @@ -272,7 +272,16 @@ automatically get updated with your changes!
## Making a PR

You can submit your PR for inclusion using the following
[instructions](./github/github.html#opening-a-pull-request-in-github).
[instructions](./github/github.html).

Pay special attention to signing your commit with the `-s` option:

```bash
git commit -s -m "My Doc change"
```

This states that your changes conform to the [Developer Certificate of
Origin](https://en.wikipedia.org/wiki/Developer_Certificate_of_Origin).

Before your PR can be included in the appropriate `fabric` or `fabric-docs-i18n`
repository, it must be approved by an appropriate maintainer. For example, a
Expand Down
15 changes: 14 additions & 1 deletion docs/source/international_languages.md
Expand Up @@ -90,6 +90,8 @@ as spoken in Mexico:
```bash
cp -R pt_BR/ es_MX/
```
Alternatively, you could copy the `docs/` folder from the `fabric`
repository.

1. Customize the `README.md` file for your new language using [this
example](https://github.com/hyperledger/fabric-docs-i18n/tree/master/docs/locale/pt_BR/README.md).
Expand Down Expand Up @@ -183,6 +185,18 @@ You can now request, via the [`i18n rocket
channel`](https://chat.hyperledger.org/channel/i18n), that your translation is
included on the documentation website.

## Translation tools

When translating topics from US English to your international language, it's
often helpful to use an online tool to generate a first pass of the translation,
which you then correct in a second pass review.

Language workgroups have found the following tools helpful:

* [`DocTranslator`](https://www.onlinedoctranslator.com/)

* [`TexTra`](https://mt-auto-minhon-mlt.ucri.jgn-x.jp/)

## Suggested next topics

Once you have published the mandatory initial set of topics on the documentation
Expand Down Expand Up @@ -222,7 +236,6 @@ order of translation in your workgroup.
This topic covers the latest features in Hyperledger Fabric.



Finally, we wish you good luck, and thank you for your contribution to
Hyperledger Fabric.

Expand Down

0 comments on commit dd556f3

Please sign in to comment.