How to build and deploy the documentation

[Davidmc07]

1. Install Ruby

Download the ruby installer for windows from here, execute it and follow the instalation instructions.

2. Install asciidoctor

Run the following command on the windows cmd: gem install asciidoctor asciidoctor-diagram

3. Install node.js

Download the node.js installer from here, execute it and follow the installation instructions.

4. Run and deploy

• Open the node.js command prompt and move to the "docs" directory inside the project.
• Install the dependencies with npm install (only first time).
• Use the command 'npm run build' for generating the documentation (html file can be found in "build/index.html").
• The documentation can be deployed with npm run deploy but avoid using it from feature branches as it removes any change previously deployed if it is not present in that branch.