Add documentation for operations
Documentation is initiated and we need now to better organize it. Here are the questions to be answered.
Foreword
Target OS / architecture is: Ubuntu 16.04 x86_64
Documentation to run tests
- What are the prerequisites to execute the tests:
- for the back-end?
- for the front-end?
- What is the procedure to run unit-tests:
- for the back-end?
- for the front-end?
- What is the procedure to run E2E-tests:
- for the back-end?
- for the front-end?
(By now, CI with Docker does it correctly, but I can't reproduce it in a VM)
Hardware & network provisioning
- Are there any specificities for RAM / CPU / disk space requirement?
- Are there any other specificities to be aware of?
- What are the network flux ? (Among various questions, this should answer how front and back are communicating, and whether the DB can located on a different host/network)
As an example, one may have a look at Hardware provisioning for Asqatasun
Documentation to build the app
- What are the prerequisites to build:
- the back-end?
- the front-end?
- What are the procedures or recommendations to build:
- the back-end?
- the front-end?
Documentation to install the app
- What are the prerequisites to install the app? (Please consider that no build tools are available on a production host.)
- What is the procedure to deploy the application?
Documentation for operations
- How to start/stop services?
- Where are located log files?
- How to change verbosity of log files ?
- How to backup? (what, where, how)
- How to supervise? (what, where, how)