Skip to content

DEV.md

Latest commit

 

History

History
111 lines (82 loc) · 3.71 KB

DEV.md

File metadata and controls

111 lines (82 loc) · 3.71 KB

Documentation for core contributors

RST substitutions

Installing Transifex CLI and Sphinx

We are using Transifex, and so you will need their CLI tool to push or pull translations.

It is recommended to install Sphinx into a dedicated Python environment. For example:

python3 -m venv .venv
.venv/bin/pip install -r requirements.txt

To install Transifex, see https://developers.transifex.com/docs/cli. For linux, the fastest way:

cd /tmp; \
curl -L "https://github.com/transifex/cli/releases/latest/download/tx-linux-amd64.tar.gz" | tar xz --skip-old-files; \
sudo mv tx /usr/local/bin/tx

You should create a ~/.transifexrc file containing:

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

In the password parameter and in the token parameter, you should set an API Key you have to generate from your Transifex account.

Updating the list of strings to translate

You must first generate the .pot files, from the .rst files:

make gettext

Then you push them to Transifex

./push_to_transifex.sh

Updating translated strings

It is not recommended modifying by hand files into i18n/! We prefer to translate strings into Transifex.

To retrieve translated string:

./update_from_transifex.sh -f

You can then commit them.

Adding a new language

The language should be created into Transifex. When there are enough translated strings, you can download translated files with tx pull. See above. Update the list of available language into :

  • the Makefile file in the TRANSLATIONS variable.
  • the lizmap_versions.json in the locales variable.
  • the update_from_transifex.sh in AVAILABLE_LOCALES variable.
  • the .gitlab-ci.yml in retrieve_po_and_build stage.

Releasing a new version of Lizmap

When a new major version of lizmap has been released, be sure the documentation is updated into the master branch.

When the documentation is ready to release X.Y from the master branch:

  1. Set the version number into source/conf.py about X.Y, mainly the release without the suffix.
  2. Update the file source/lizmap_versions.json
  3. Update gitlab-ci about this new branch
  4. Commit these 3 files : Release version X.Y
  5. Create a new branch git checkout -b lizmap_X_Y (replace X and Y).
  6. Configure a new schedule in the CI configuration for this new branch
  7. On the master branch, set the next version into source/conf.py and source/lizmap_versions.json
  8. Push the new branch and the master branch
  9. In the server configuration, change the target of the symbolic link 'current' variable webpublic_docslizmap_current_version in "server-bootstrap"
  10. Copy the source/lizmap_versions.json into all maintained branches, it should be the same for all.

Archive an old version

  1. Checkout the branch
  2. ./update_from_transifex.sh -f
  3. git commit -am 'Archive LWC BRANCH translations, EOL'
  4. Remove all ressources on Transifex for the BRANCH
  5. Update source/lizmap_versions.json to add a single link to the current branch, see a branch below, like 3.4
  6. git commit -am 'Add single link to the current maintained branch'
  7. sed -i 's/\'outdated\': False,/\'outdated\': True,/g' source/conf.py
  8. git commit -am 'The branch is now outdated'
  9. Adapt the CI on the master branch about branches