Localization of The Qubes OS Documentation

Announcement
1

Announcement

We’re glad to announce that the :tada: qubesos-docs-l10n :tada: project is now published:

The goal of this project is to translate The Qubes OS Documentation into multiple languages. Translations are contributed via the Crowdin platform, automatically synchronized with the GitHub repository, and can be previewed on GitHub Pages.

How to Contribute Translations?

To contribute the translations, please follow the following steps:

  1. Create an account on Crowdin Enterprise if you don’t have one.
  2. Log in and go to the qubesos-docs-l10n project.
  3. Choose the target language you would like to contribute.

If the target language is not yet supported, please open an issue to request the new language. Once the requested language is added, you can start translating.

How to Reuse Translations?

If the upstream project or anyone wants to reuse the .po files maintained by the this project, they can download the .po files from the po/<version> branch with the following command:

git clone --branch=po/<version> https://github.com/localizethedocs/qubesos-docs-l10n.git <locale-dir>

Those po/<version> branches are created to facilitate reusage by the upstream project. For instance, the zh_TW documentation for the main version can be generated using the demo commands below:

Click to expand the demo commands 
BRANCH=main
VERSION=main
LANGUAGE=zh_TW
BUILDER=html
REPODIR=$(pwd)/qubesos-docs
VENVDIR=$REPODIR/.venv

# Prepare the repository and environment
git clone --branch=$BRANCH --recurse-submodules https://github.com/QubesOS/qubes-doc.git $REPODIR
cd $REPODIR
conda create --prefix $VENVDIR --yes
conda activate $VENVDIR
conda install python=3.13 -c conda-forge -c nodefaults --yes
export PYTHONNOUSERSITE=1
python -m ensurepip --default-pip
python -m pip install -r requirements.txt

# Clone the .po files to the 'locale' directory
git clone --branch=po/$VERSION https://github.com/localizethedocs/qubesos-docs-l10n.git locale

# Build the documentation
sphinx-build \
    -b $BUILDER \
    -D language=$LANGUAGE \
    -D locale_dirs=locale \
    -D gettext_compact=0 \
    -D gettext_additional_targets=index,literal-block,raw \
    . \
    ./_build/$LANGUAGE

# Preview the documentation
firefox ./_build/$LANGUAGE/index.html