This file contains all the information about the translation of the model. We are talking about all text around test and actions (questions, descriptions …).

For the user interface translation (e.g. releases, FAQ, button's text, etc...), please refer to this wiki.

Table of content

• Configuration
  • DeepL API key
  • Dev dependencies
• Available languages
• Architecture
• Workflow
  • Modification of the ./data files
  • Modification of the ./personas files
  • Improving an existing translation
    • Contribution guide for translation from GitHub
  • Translating region models
• Available scripts
  • translate-rules.js
  • check-translation.js
  • rulesToJSON.js
  • translate-personas.js
  • personasToJSON.js
  • check-personas.js
  • translateRegionModel.js

Configuration

DeepL API key

To be able to run all available scripts you need to have defined the env variable DEEPL_API_KEY with a valid DeepL API key.

You can specify it when running the command like:

DEEPL_API_KEY=<your-api-key> yarn <cmd>

or saving it in your .bashrc file -- or other terminal config file.

Dev dependencies

Before running any scripts, make sure that you have all the dependencies installed by running:

yarn install

Available languages

Currently, the model and the website UI are available in:

• fr -- is the reference language.