Guide: how to add / edit a language

[aleksey-hoffman]

If you want to contribute and add / edit a language, follow these instructions:

Edit existing language

Method 1: online on Github

1. Open localization directory: src/localization/locales;
2. Open the localization file of the language you want to edit, for example (fi.json for Finnish, ch.json for Chinese);
3. Click "edit" button (pencil icon);
4. Edit as many values as you want. Keep in mind: each translation entry has the key and the value: {"key": "value"}. You should only modify the value (do not touch the key itself). Make sure each value is wrapped with double quotes. If you have nested double quotes, use the escape symbol to ignore them, for example: "testString": "Some \"Test string\" here";
5. When you are done editing, scroll to the bottom of the page and add the commit title and create a new branch for your changes, then click "Propose changes" button:

Method 2: online on Github via VScode editor:

1. Open localization directory in the editor;
2. Navigate to the localization file of the language you want to edit;
3. Do the step 4 in method 1 above;
4. Go to the "Source control" tab
5. Add a message and click "Commit and push" button

Add new language

Before you add a new language, first, open the project's localization directory: src/localization/locales and make sure the translation file for your language doesn't exist yet.

Method 1: online on Github

1. Open the English translation file: src/localization/locales;
2. Copy raw contents (you can see the copy button there);
3. Go back to the localization directory: src/localization/locales;
4. Create a new file for your language with .json extension and the name containing 2-letter long name (see ISO 639-1 code list), for example:

• en.json for English;
• de.json for German;
• fi.json for Finnish;

5. Open your new file;
6. Click "edit" button (pencil icon);
7. Translate as many values to your language as you want. Keep in mind: each translation entry has the key and the value: {"key": "value"}. You should only modify the value (do not touch the key itself). Make sure each value is wrapped with double quotes. If you have nested double quotes, use the escape symbol to ignore them, for example: "testString": "Some \"Test string\" here";
8. When you are done translating, scroll to the bottom of the page and add the commit title and create a new branch for your changes, then click "Propose changes" button:

Method 2: online on Github via VScode editor:

1. Open localization directory in the editor;
2. Copy raw contents of the en.json file;
3. Do the steps 4-5 and then step 7 in method 1 above;
4. Go to the "Source control" tab
5. Add a message and click "Commit and push" button

[aleksey-hoffman]

The best way to find where a specifc line of text is occuring is to search the text you can already see in Sigma UI. For example:

1. Go to Settings page
2. See where the text of line is located to better understand how it should be translated
3. Find the line of text in the English en.json file using Ctrl + F and only then translate it in the target translation file.