Restructure docs repository

micado-scale · Aug 21, 2018 · 53048fc · 53048fc
1 parent 4d69817
commit 53048fc
Show file tree

Hide file tree

Showing 10 changed files with 6 additions and 4 deletions.
diff --git a/Makefile → user_documentation/Makefile b/Makefile → user_documentation/Makefile
diff --git a/conf.py → user_documentation/conf.py b/conf.py → user_documentation/conf.py
@@ -51,7 +51,7 @@
 source_suffix = '.rst'
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = 'rst/index'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/requirements.txt → user_documentation/requirements.txt b/requirements.txt → user_documentation/requirements.txt
diff --git a/application_description.rst → ...mentation/rst/application_description.rst b/application_description.rst → ...mentation/rst/application_description.rst
diff --git a/dashboard.rst → user_documentation/rst/dashboard.rst b/dashboard.rst → user_documentation/rst/dashboard.rst
@@ -4,6 +4,7 @@ Dashboard
 MiCADO has a simple dashboard that collects web-based user interfaces into a single view. To access the Dashboard, visit ``http://IP:4000``.
 
 The following webpages are currently exposed:
+
 * Docker visualizer: it graphically visualizes the Swarm nodes and the containers running on them.
 * Grafana: graphically visualize the resources (nodes, containers) in time.
-* Prometheus: monitoring subsystem. Recommended for developers, experts.
+* Prometheus: monitoring subsystem. Recommended for developers, experts.
diff --git a/deployment.rst → user_documentation/rst/deployment.rst b/deployment.rst → user_documentation/rst/deployment.rst
@@ -10,9 +10,10 @@ Git & Ansible 2.4 or greater are needed on your (local) machine to run the Ansib
 
 **The version of Ansible in the Ubuntu 16.04 APT repository is outdated and insufficient**
 
-Install Ansible on Ubuntu 16.04
--------------------------------
+Ansible
+-------
 
+Install Ansible on Ubuntu 16.04.
 ::
 
    sudo apt-get update

diff --git a/index.rst → user_documentation/rst/index.rst b/index.rst → user_documentation/rst/index.rst
diff --git a/release_notes.rst → user_documentation/rst/release_notes.rst b/release_notes.rst → user_documentation/rst/release_notes.rst
diff --git a/rest_api.rst → user_documentation/rst/rest_api.rst b/rest_api.rst → user_documentation/rst/rest_api.rst
diff --git a/tutorials.rst → user_documentation/rst/tutorials.rst b/tutorials.rst → user_documentation/rst/tutorials.rst