Kolibri Docs

What is this?

This is the Documentation repository of Kolibri, where documentation is built.

To translate the documentation, please visit our CrowdIn project kolibri-docs

Building the docs locally

You will need an environment with make

# Create a Python 3 virtual environment using Virtualenvwrapper
# See: https://virtualenvwrapper.readthedocs.io/
$ mkvirtualenv -p python3 kolibri-docs

# Install Python requirements
$ pip install -r requirements.txt

# Build docs with Sphinx
$ make docs

# Open the docs with Firefox
$ firefox docs/_build/html/index.html

# Build a translated (Spanish) version
$ make docs-translated lang=es

# Install the crowdin-cli client to download/upload translations
$ make crowdin-install

# Fetch translations
$ CROWDIN_API_KEY="your-secret-key" make crowdin-download crowdin-branch=release-v0.7.x

Workflow

When a new release of Kolibri happens, we track that release in a branch here with the exact same name. We build this branch on Read The Docs.

• Changes to the ENGLISH documentation are accepted through Pull Requests here.
• Changes to other languages should happen on CrowdIn

When a new release happens and the English documentation is finalized, the source messages for translation are uploaded to CrowdIn.

The languages (you're always welcome to request a new one!) are then worked out by translators and approved. Once a language is improved sufficiently, we can fetch the latest strings from CrowdIn and open up a new Pull Request here for the appropriate branch.