Browse Source

Documentation - added contributing translations guide

- Fixes #7115
Ogunbanjo oluwadamilare 2 years ago
parent
commit
1428333af8

+ 1 - 0
CHANGELOG.txt

@@ -7,6 +7,7 @@ Changelog
  * Add custom permissions section to permissions documentation page (Dan Hayden)
  * Remove unsquashed `testapp` migrations (Matt Westcott)
  * Switch to using Willow instead of Pillow for images (Darrel O'Pry)
+ * Add documentation for how to get started with contributing translations for the Wagtail admin (Ogunbanjo Oluwadamilare)
  * Fix: Make sure workflow timeline icons are visible in high-contrast mode (Loveth Omokaro)
  * Fix: Ensure authentication forms (login, password reset) have a visible border in Windows high-contrast mode (Loveth Omokaro)
  * Fix: Ensure visual consistency between buttons and links as buttons in Windows high-contrast mode (Albina Starykova)

+ 1 - 0
CONTRIBUTORS.rst

@@ -650,6 +650,7 @@ Contributors
 * Oluwaloseyi Adeleye
 * Dennis Onyeka
 * Precious Arinda
+* Ogunbanjo Oluwadamilare
 
 Translators
 ===========

+ 2 - 0
docs/advanced_topics/i18n.md

@@ -1,3 +1,5 @@
+(internationalisation)=
+
 # Internationalisation
 
 ```{contents}

+ 2 - 1
docs/contributing/index.md

@@ -29,7 +29,7 @@ committing
 
 Wagtail has internationalisation support so if you are fluent in a non-English language you can contribute by localising the interface.
 
-Translation work should be submitted through [Transifex](https://explore.transifex.com/torchbox/wagtail/).
+Translation work should be submitted through [Transifex](https://explore.transifex.com/torchbox/wagtail/), for information on how to get started see [](contributing_translations).
 
 ## Other contributions
 
@@ -58,6 +58,7 @@ python_guidelines
 ui_guidelines
 documentation_guidelines
 documentation_modes
+translations
 security
 release_process
 ```

+ 43 - 0
docs/contributing/translations.md

@@ -0,0 +1,43 @@
+(contributing_translations)=
+
+# Translations
+
+Wagtail uses [Transifex](https://www.transifex.com/) to translate the content for the admin interface. Our goal is to ensure that Wagtail can be used by those who speak many different languages. Translation of admin content is a great way to contribute without needing to know how to write code.
+
+```{note}
+For translations and internationalisation of content made with Wagtail see [](internationalisation).
+```
+
+## Translation workflow
+
+Wagtail is localised (translated) using Django's [translation system](django:topics/i18n/translation) and the translations are provided to and managed by [Transifex](https://www.transifex.com/), a web platform that helps organisations coordinate translation projects.
+
+Translations from Transifex are only integrated into the repository at the time of a new release. When a release is close to being ready there will be a RC (Release Candidate) for the upcoming version and the translations will be exported to Transifex.
+
+During this RC period, usually around two weeks, there will be a chance for all the translators to update and add new translations. We will also notify the `#translators` channel in the Wagtail Slack group at this time.
+
+These new translations are imported into Wagtail for any subsequent RC and the final release. If translations reach a threshold of about 80%, languages are added to the default list of languages users can choose from.
+
+### How to help out with translations
+
+-   Join the Wagtail community on [Slack](https://wagtail.org/slack/)
+-   Search through the channels to join the `#translator` channel and introduce yourself
+-   Go to [Transifex](https://www.transifex.com/)
+-   Click on start for free
+-   Fill in your Username, Email and Password
+-   Agree to the terms and conditions
+-   Click on free trial or join an existing organisation
+-   Join [Wagtail](https://www.transifex.com/torchbox/wagtail/dashboard/) and see the list of languages on the dashboard
+-   Request access to become a member of the language team you want to work with on Slack (mention your Transifex username)
+-   A view resources button appears when you hover over the ready to use part on the right side of the page
+-   Click on the button to get access to the resources available
+-   This takes you to the language section
+-   This page has a translation panel on the right and a list of strings to be translated on the left
+-   To translate a project, select it and enter your translation in the translation panel
+-   Save the translation using the translation button on the panel
+
+## Additional resources
+
+-   [](django:topics/i18n/translation)
+-   A screen-share [Wagtail Space US 2020 Lightning Talk](https://www.youtube.com/watch?v=sLI_AuOMUQw&t=17s) that walks through using Transifex step-by-step
+-   [Core development instructions for syncing Wagtail translations with Transifex](https://github.com/wagtail/wagtail/wiki/Managing-Wagtail-translations)

+ 1 - 0
docs/releases/4.2.md

@@ -17,6 +17,7 @@ depth: 1
  * Add custom permissions section to permissions documentation page (Dan Hayden)
  * Wagtail's documentation (v2.9 to v4.0) has been updated on [Dash user contributions](https://github.com/Kapeli/Dash-User-Contributions) for [Dash](https://kapeli.com/dash) or [Zeal](https://zealdocs.org/) offline docs applications (Damilola Oladele, (Mary Ayobami)
  * Switch to using [Willow](https://github.com/wagtail/Willow/) instead of Pillow for images (Darrel O'Pry)
+ * Add documentation for how to get started with [contributing translations](contributing_translations) for the Wagtail admin (Ogunbanjo Oluwadamilare)
 
 ### Bug fixes