Deprecated I18N Process (to be archived after Redwood)

Owned by Omar Al-Ithawi
May 04, 2024
2 min read

This document exists temporarily for comparing with the updated OEP-58 instructions.

Deprecated Instructions (copied from Process to Create an Open edX Release)

2b. Update and upload translations on the test branch

This step is out of date. The release manager hasn’t done this since Nutmeg or earlier. Instead:

  • For major releases: Reach out to #wg-translations and inform them that the <zebrawood>.1 has been tagged. Hopefully, someone will know what that means and help you out.

  • For major & minor releases:@Régis B. has some particular steps he does with openedx-i18n as part of the Tutor release process.

This should all be replaced when OEP-58 is implemented.

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

2b1. 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.

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

2b2. 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)

make dev-requirements curl -o- https://raw.githubusercontent.com/transifex/cli/master/install.sh | bash

2b3. Transifex Credentials

Add your transifex credentials to ~/.transifexrc. Replace {TOKEN} with a token from Transifex.

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

2b4. 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.

2b5. 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.