Users guide: how to update it

Since Rocky we use ReadTheDocs for the User Guide

Prepare your machine (if needed)

The operations reported in this section must be executed only once.

The following instructions have been tested on CentOS7:

Install sphinx:

yum install python-sphinx_rtd_theme python-sphinx

The following operations must be done each time it is necessary to update the user guide. They can be done as normal user

Download the sources from git:

$ git clone https://github.com/CloudVeneto/CVUserGuide.git
$ cd CVUserGuide

Make your changes. Also edit the file source/conf.py increasing the last number (the one after the ".") for "release" and "version".

Try to build:

make html

Check in a browser build/index.htm

If you are happy, commit and push:

git add <modified files>
git commit -a
git push