/iroha-docs-l10n

Iroha Documentation

Primary LanguageShellCreative Commons Attribution 4.0 InternationalCC-BY-4.0

Welcome to localisation of Hyperledger Iroha!

Here is a little instruction for both Contributors (people ready to do the translations) and Maintainers (Iroha maintainers who keep translations in order, and prepare all the tech stuff to make translations easy and comfortable).

If you want to translate

First of all – thank you!

Your help is much appreciated – because we want Iroha to be accessible to anyone, to help developers from all around the world build great and secure solutions on blockchain, and so your contribution is very important.

Now, the process

When you decide you want to translate, please create an issue in this repository or even better – contact maintainers and let them know about your intention.

So, to start you need to contact the maintainers and let them know:

  • to what language you are ready to translate;
  • what version of Iroha would you like to translate

Maintainers will create a special folder for the language and copy text files in English into it. You will need to translate them directly. Let's see how to do that (if you are not familiar with Git):

If you are not very familiar with basic operations in terminal, like changing folders or creating them, please check out this small tutorial. Please note they can differ depending on your operating system, but they are pretty easy to Google anyway.

  1. Fork https://github.com/hyperledger/iroha-docs-l10n.

  2. Clone the repository: git clone https://github.com/hyperledger/iroha-docs-l10n.git.

  3. Checkout into the branch that represents the version of Iroha that you want to translate.

  4. Just open the folder in any text editor you find convenient (for example, the author of this instruction uses Sublime) and translate the text.

  5. When your part is done, please push the changes to your fork and then open a pull request into the main repository.

If you need any help with setting up remotes or other Git-related issues with this – let us know, we'll help.

Several people can work on the translation within 1 pull request, sending different commits.

If you want to maintain the translations

Brace yourself, my friend – being a l10n maintainer is not easy but very rewarding!

First of all, be aware that to have access to managing the repository, you'll need to contact the main project team.

If you are a maintainer already, here's what you need to do to add a new version (branch) or a new language.

To add a new version

Easy. Just create a new branch from default and change the submodule's version:

  1. Add a submodule of Iroha (will be needed to get the references for translations): git submodule add --force https://github.com/hyperledger/iroha.git.

  2. Get into that Iroha folder.

  3. Checkout to the relevant version (tag) of Iroha (use this as a reference of different versions).

  4. Run the initialize_language script with the code of the new language as an argument from the repository root directory. The script will create a folder for the language with all the necessary files: some of them (text files) will be real copies in English, and some – like images – will be symlinks.

  5. Contact the maintainers with access to ReadTheDocs admin pages (both main Iroha and localisation projects) to connect and enable the translation after it is finished and merged.