Merge pull request #516 from opengisch/how_to_contribute_to_translations

How to contribute to translations
opengisch · Jan 22, 2025 · e1dcca3 · e1dcca3
2 parents b42f97c + d3cc0ca
commit e1dcca3
Show file tree

Hide file tree

Showing 8 changed files with 70 additions and 0 deletions.
diff --git a/documentation/assets/images/transifex_translation_01.png b/documentation/assets/images/transifex_translation_01.png
diff --git a/documentation/assets/images/transifex_translation_02.png b/documentation/assets/images/transifex_translation_02.png
diff --git a/documentation/assets/images/transifex_translation_03.png b/documentation/assets/images/transifex_translation_03.png
diff --git a/documentation/assets/images/transifex_translation_04.png b/documentation/assets/images/transifex_translation_04.png
diff --git a/documentation/assets/images/transifex_translation_05.png b/documentation/assets/images/transifex_translation_05.png
diff --git a/documentation/assets/images/transifex_translation_06.png b/documentation/assets/images/transifex_translation_06.png
diff --git a/documentation/get-started/how-to-contribute-translation.en.md b/documentation/get-started/how-to-contribute-translation.en.md
@@ -0,0 +1,69 @@
+---
+title: How to contribute to translation
+tx_slug: documentation_get-started_how-to-contribute-translation
+---
+
+# Contributing to the Translation
+
+Translations for the QField app are managed through the **Transifex** platform.
+
+## 1. Access the Translation Platform
+
+1. Go to the [OPENGIS Dashboard on Transifex](https://www.transifex.com/opengisch/).
+2. Log in or create an account on Transifex.
+
+## 2. Choose a Language to Contribute
+
+1. Select a project you want to contribute to.
+2. Select the language you want to contribute to.
+3. Look for languages requiring translation. For these languages, you'll see a "Translate" button. Click on it.
+
+!![](../assets/images/transifex_translation_01.png,850px)
+
+You'll see a "Join Team" link. Click it and wait for approval (you'll receive an email).
+
+## 3. Navigate to the Translation Interface
+
+1. Use the filters to streamline your work:
+
+    - Click on the "Status" dropdown menu.
+    - Choose **Translated**.
+
+!![](../assets/images/transifex_translation_02.png,850px)
+
+   - Then choose **No**.
+
+!![](../assets/images/transifex_translation_03.png,850px)
+
+## 4. Translate Strings
+
+1. For each untranslated string:
+
+    - Enter the equivalent translation in the "Type your translation here" field.
+    - Ensure the translation is accurate and contextually appropriate.
+
+!![](../assets/images/transifex_translation_04.png,850px)
+
+2. Follow these important guidelines while translating:
+
+    - **Preserve Cases**: Retain uppercase and lowercase letters as required.
+    - **Preserve Reserved Words and Formatting**: Do not alter placeholders like `()`, `%1`, `<strong>`, or `<br>`.
+
+!![](../assets/images/transifex_translation_05.png,850px)
+
+3. Once the translation is complete, click the **Save changes** button.
+
+!![](../assets/images/transifex_translation_06.png,850px)
+
+## 5. Review Your Translation
+
+- Confirm that the translation aligns with the guidelines provided in the [Translation process](https://github.com/opengisch/QField-docs?tab=readme-ov-file#translation-process).
+
+## 6. Synchronization and Testing
+
+- Translations are typically synchronized with the QField app’s master codebase each day.
+- To see your translation reflected in the app:
+    - Join the [QField Beta Program](https://play.google.com/apps/testing/ch.opengis.qfield_dev) for early access to new releases with this translations.
+
+If your language is not yet available, we will happily add it for you.
+Just open an issue on GitHub repository and tell us which language you would like to translate it to.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -63,6 +63,7 @@ nav:
       - get-started/sponsor.md
       - get-started/license.md
       - get-started/contribute.md
+      - get-started/how-to-contribute-translation.md
       - get-started/third-part-tutorials.md
   - How-to guides:
       - how-to/index.md