From e1193bc26d945d71c4b39875c4b02b206039ee20 Mon Sep 17 00:00:00 2001 From: Sabrina Demagny Date: Tue, 11 Mar 2025 12:39:15 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D(i18n)=20add=20details=20about=20tr?= =?UTF-8?q?anslation=20process?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Propose a way to check if every is ok before upload on crowdin Add information about crowdin api token --- docs/i18n.md | 31 +++++++++++++++++++++++++++++-- 1 file changed, 29 insertions(+), 2 deletions(-) diff --git a/docs/i18n.md b/docs/i18n.md index 817bdc1..f3b8023 100644 --- a/docs/i18n.md +++ b/docs/i18n.md @@ -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