Skip to content

Commit 049dadb

Browse files
committed
Review of @erral's PR as commits instead of using GitHub's UI to save work and review cycles
- contributing-translations.md
1 parent 703ada6 commit 049dadb

File tree

1 file changed

+44
-14
lines changed

1 file changed

+44
-14
lines changed

docs/i18n-l10n/contributing-translations.md

Lines changed: 44 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,40 +14,70 @@ html_meta:
1414
How to contribute to the Plone translations.
1515
```
1616

17+
This chapter of the documentation describes how to contribute to Plone's translations.
18+
Plone fully supports {term}`internationalization` and {term}`localization`.
19+
Plone Classic UI comes with 65 local language translations, and the new default frontend Volto comes with 12, at the time of this writing.
20+
However, some translations are incomplete, or certain languages have not yet been added.
21+
Translations can be added or updated as needed by the citizens of Earth.
22+
You will need to work in one repository for Plone core, and optionally another one for Volto.
1723

18-
## Introduction
24+
25+
(contributing-plone-core-translations-pre-requisites-label)=
26+
27+
## Pre-requisites
1928

2029
Request write access to https://github.com/collective/plone.app.locales to be able to commit your translation directly.
2130

2231
To do so, [join the collective GitHub organization](https://collective.github.io/).
2332

24-
You can fork the repository and work from there or create a new branch and work in that branch.
33+
Optionally sign the [Plone Contributor Agreement](https://plone.org/foundation/contributors-agreement) for translating Volto.
34+
35+
36+
(contributing-plone-core-translations-translate-plone-classic-ui-label)=
37+
38+
## Translate Plone Classic UI
2539

26-
## Translate Plone
40+
The process of translating Plone Classic UI is the following.
2741

28-
The process of translating Plone UI is the following:
42+
1. Go to https://github.com/collective/plone.app.locales and clone it into your computer.
2943

30-
1. Go to https://github.com/collective/plone.app.locales and clone it into your computer
44+
2. Create a new branch to work on your translations.
45+
Name the branch with something identifiable.
46+
For example: `{language}-{date}` (`fr-20220731`).
3147

32-
2. Create a new branch to work on your translations. Name the branch with something identifiable. For example: {language}-{date} (ex. fr-20220731)
48+
3. Either update or create a translation.
3349

34-
3. Translate the `po` files under your language of choice at plone/app/locales/locales/{language_code}/LC_MESSAGES/*.po. In Classic UI we have several language files because some of the original messages are spread over several language domains and products.
50+
- To _update_ an existing translation, translate the {term}`po` files under your language of choice at `plone/app/locales/locales/{language_code}/LC_MESSAGES/*.po`.
51+
In Classic UI, we have several language files because some of the original messages are spread over several language domains and products.
52+
- To _create_ a translation, create a new directory at `plone/app/locales/locales/{language_code}/LC_MESSAGES`, copy all the `.pot` files in `plone/app/locales/locales` to your new directory, rename the files in your directory by changing the file extension to `.po`, and start translating.
3553

36-
4. Commit your changes and add a Pull Request with them. Try to have a review from a colleague, specially in case you are translating a file with already some translations. This is just to have coherent translations all over Plone.
54+
4. Commit your changes, and create a pull request with them.
55+
Request a review from a colleague, especially if you are translating a file that already has some translations.
56+
You can check the file's commit history with `git blame <filename>` to see previous contributors and request a review from them.
57+
This is to ensure coherent translations throughout Plone.
3758

3859

60+
(contributing-plone-core-translations-translate-volto-label)=
61+
3962
## Translate Volto
4063

41-
The process of translating Volto UI is the following:
64+
The process of translating the Volto frontend is the following.
65+
66+
1. Go to https://github.com/plone/volto and clone it into your computer.
67+
68+
2. Create a new branch to prepare the translations.
69+
Name the branch with something identifiable.
70+
For example: `{language}-{date}` (`fr-20220731`).
71+
72+
3. Either update or create a translation.
4273

43-
1. Go to https://github.com/plone/volto 3 and clone it into your computer
44-
2. Create a new branch to prepare the translations. Name the branch with something identifiable. For example: {language}-{date} (ex. fr-20220731)
74+
- To update a translation, translate your language's `po` file found at `locales/{language_code}/LC_MESSAGES/volto.po`.
75+
- To create a new translation, create a new directory at `locales/{language_code}/LC_MESSAGES/`, copy the file `locales/volto.pot` to `locales/{language_code}/LC_MESSAGES/volto.po` (note to drop the trailing `t`), and start translating.
4576

46-
3.a Translate your language `po` file found at locales/{language_code}/LC_MESSAGES/volto.po
77+
4. Commit your changes, and create a pull request.
4778

48-
3.b Alternatively, if your language file doesn't exist, create a new folder at locales/{language_code}/LC_MESSAGES/, copy over the volto.pot file there as volto.po and start translating.
4979

50-
4. Commit your changes and add a Pull-Request.
80+
(contributing-plone-core-translations-support-label)=
5181

5282
## Support
5383

0 commit comments

Comments
 (0)