Skip to content
Yannick Warnier edited this page May 29, 2023 · 3 revisions

Welcome to the Chamilo Documentation wiki!

If you'd like to start helping make Chamilo's documentation better, here are a few bits of information and some conventions to help you out.

Documentation conventions

Branches

This project is divided into branches. Branches are simply different versions of the documentation, which try to follow closely the Chamilo software's versions.

We distinguish major from minor versions of Chamilo:

  • Major versions are, for example, version 1.9, 1.10, 1.11 and 2.0 of Chamilo.
  • Minor versions are 1.9.8, .., 1.10.2, 1.10.4, 1.10.6, .., 1.11.2, 1.11.4, .., 1.11.18, 1.11.20, etc

All major versions have a branch that extends the major version number with an x letter, so the 1.11 branch is called 1.11.x.

The Chamilo Documentation maintains different versions that reflect only major Chamilo versions, so branches will start with 1.11.x. However, if the Chamilo software has its own translation system, for the documentation we rely on different people to contribute documentation in different languages. For this, we extend the version number with the language code (usually two lowercase letters, but where there are significant differences between countries, we might use code like "pt_BR" instead).

So the English guide for Chamilo is the default, so it will reside in branch "1.11.x", while the French version will reside in branch "1.11.x-fr".

In short, depending on what guide you want to contribute to, you should first identify your branch, then check "https://docs.chamilo.org/", select your guide version and language there (in the upper left menu), then identify the page you want to update, find the corresponding page here on Github and submit changes.

Clone this wiki locally