About the Documentation

About the Documentation#

This section contains the changelogs of the Carbonio Documentation releases. Since the documentation is released more often than the software, we keep a list of changes made to the documentation on a monthly basis, starting from October 2024.

Changelogs are divided in two sections:

  • New and Updated Content contains all the changes done, including pieces that have been amended, removed, or have been written from scratch

  • Bugfix List are errors or mistakes introduced in the documentation and that have been corrected. For example, because we wrote a wrong command.

Each entry in the changelog consists of

  • a unique id (e.g., 202410-812) consisting of a date (year and month), and a number (an internal reference to the task)

  • a title (e.g., Move Requirements Before Ansible Upgrade)

  • a description with links to the documentation and the PRs that introduced the changes

Contribution to the Documentation#

The source code of Carbonio‘s documentation is available in a public GitHub repository.

We are happy to accept any kind of documentation, written according to the guidelines, in form of a pull request. In case you have an idea for the documentation or you do not feel confident using Python Sphinx (the framework we use for writing documentation), you can send an e-mail to the address documentation@zextras.com.