Skip to content

Latest commit

 

History

History
61 lines (48 loc) · 2.76 KB

TRANSLATING.md

File metadata and controls

61 lines (48 loc) · 2.76 KB

Translating the Code for IBM i Documentation Web site.

Translating is Contributing !

Translating the documentation Web site is contributing to Code For IBMI , so please read CONTRIBUTING before.

Docsify

A magical documentation site generator.

Code for IBMi uses Docsify to publish the Web site code-for-ibmi Documentation.

To sum it up , this tools transforms the markdown files stored in the docs folder to a web site using github pages.

This site is in English by default but it's possible to add a new language to improve the learning curve of the none english's adopters.

Please read above How to initiate or How to help in a new translating.

Add a new language is to add a new folder under docs folder with all docs's markdown files translated. To be meaningful we call this folder with the ISO Language Code table

So for french we used fr-FR.
then the user switches between all the languages using the translations navbar in the right corner.

Process to add a new language

We choose to use french translation as an example to explain the process.

  1. Contributing

    1. You fork and clone
    2. Create an new branch

  2. Translating
    👁️‍🗨️ To make me easier the translating,I'm using this useful extension Vscode Google Translate

    1. Add the new language in the navbar using the ISO Language Code table.
    2. Copy the docs folder as the /docs/fr-FR folder.
    3. Remove the _navbar.md under the /docs/fr-FR folder.
    4. Start translating the side bar You have to change all the path to yours pages by adding the directory (/fr-FR/) in this case .. 
      - [Code for IBM i](/)
  - [Login](/pages/login.md)
...
      to 
      - [Code for IBM i](/fr-FR/)  
  - [Connexion](/fr-FR/pages/login.md)  
...
    5. Then you can translate the readme.
    6. Then you can test your job.
    7. And/or translate all the markdown files under your folder.

  3. Testing locally

    1. Open a terminal in VSC
    2. Type docsify serve docs
    3. Open your navigator on the url proposed

  4. Testing Remotely

    1. Commit and push changes to your fork
    2. Deploy /docs of your fork to github pages

  5. ✔️ Make a pull request (PR)