studio/people
Archived
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

📝(i18n) add details about translation process

Browse Source 
Propose a way to check if every is ok before
upload on crowdin
Add information about crowdin api token
This commit is contained in:
Sabrina Demagny
2025-03-11 12:39:15 +01:00
parent 285647a8a9
commit e1193bc26d
1 changed files with 29 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
docs/i18n.md
View File

@@ -13,14 +13,41 @@ setup your local environment with the following environment variables:
cp ./env.d/development/crowdin.dist ./env.d/development/crowdin
```
Then fill in the `CROWDIN_API_TOKEN` and `CROWDIN_PROJECT_ID` variables in the
`./env.d/development/crowdin` file.
Then fill "CROWDIN_API_TOKEN" with your token and "CROWDIN_PROJECT_ID" with the project id
in the `./env.d/development/crowdin` file.
NB: If you don't have a personal Crowdin API token, go to Crowdin interface to generate it:
Settings -> API -> Personal Access Tokens -> New token
This configuration file will be loaded by the crowdin docker instance.
## How to update the translations
### First way (safe way)
1/ Generate the translation files for both frontend and backend
```bash
make i18n-generate
```
Check locally everything is ok before uploading the files to the translation platform.
2/ Upload the files to the translation platform (crowdin):
```bash
make crowdin-upload
```
3/ Fill the missing translations on the translation platform:
=> [https://crowdin.com/project/lasuite-people](https://crowdin.com/project/lasuite-people)
4/ Download the translated files from the translation platform and compile them:
```bash
make i18n-download-and-compile
```
### Second way (faster way)
1/ Generate the translation files for both frontend and backend and upload them to the translation platform (crowdin):
```bash
make i18n-generate-and-upload