Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

3. Update and upload translations on the test branch

Using a devstack on the test branch, upload the strings to Transifex with:

...

For this method, you should be using tutor and should have openedx/edx-platform on the target release branch locally.

Tutor

In the case that this is a new release, it is best to use Tutor’s Nightly branch, otherwise the Master branch is recommended. Using tutor, open a shell in cms while mounting the local edx-platform repo set to the target release branch.

Code Block
tutor dev run cms bash -m path-to-edx-platform

Setup

There are some setup items that are necessary as of nutmeg [last updated 2022-09-01]:

  1. Install the development requirements

  2. Uninstall the old transifex-client (v2)

  3. Install the new transifex-client (v3)

Code Block
pip install -r requirements/edx/development.txt
pip uninstall transifex-client -y
curl -o- https://raw.githubusercontent.com/transifex/cli/master/install.sh | bash

Transifex Credentials

Add your transifex credentials to ~/.transifexrc. Set up your API Token and password via the Transifex Documentation. They have the form:

Code Block
https://www.transifex.com]
api_hostname = https://api.transifex.com
hostname = https://www.transifex.com
password = {PASSWORD}
rest_hostname = https://rest.api.transifex.com
token = {TOKEN}
username = api

Generate, Compile, and Upload to Transifex

Open a new bash shell within the current shell and follow these commands to generate, compile and upload Translation files. Replace {release-version} in line 5 with the name of the release. It should match the files in .tx/config.

Code Block
bash
i18n_tool extract
i18n_tool dummy;
i18n_tool generate
paver i18n_compilejs
pavertx i18n_release_push #-s This will fail and you will have to upload 2 files manually.

Manually Uploading the Translations Files

Once the translations have been compiled, the following files need to be uploaded to transifex in the Open edX Releases project.

Code Block
edx-platform/conf/locale/en/LC_MESSAGES/djangojs.po
edx-platform/conf/locale/en/LC_MESSAGES/django.po
Note
This will change .po and .mo files that will need to be committed.
-r open-edx-releases.release-{release-version} open-edx-releases.release-{release-version}-js

Manually Renaming the Translations Files

In the case that this is the first time the resources are being uploaded to Transifex, log in to Transifex, find the files named django.po and djangojs.po, confirm that the slugs (check out the url) match the release version and rename the files to match the naming convention.

Code Block
djangojs.po -> release-{release-version}-js
django.po -> release-{release-version}-js

4. Run through the native installation (until Lilac)

...