restruture user documentation

deephdc · Jan 2, 2019 · 18be348 · 18be348
1 parent a9727f9
commit 18be348
Show file tree

Hide file tree

Showing 22 changed files with 59 additions and 29 deletions.
diff --git a/.idea/dictionaries/ignacio.xml b/.idea/dictionaries/ignacio.xml
diff --git a/.idea/vcs.xml b/.idea/vcs.xml
diff --git a/source/index.rst b/source/index.rst
@@ -7,7 +7,7 @@ User documentation
 If you are a user (current or potential) you should start here.
 
 .. toctree::
-   :maxdepth: 3
+   :maxdepth: 2
 
    user/index
 

diff --git a/source/user/catalogue/image_classification.rst b/source/user/catalogue/image_classification.rst
diff --git a/source/user/examples/index.rst b/source/user/examples/index.rst
@@ -0,0 +1,8 @@
+Examples
+========
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+
+   toy_model-dog_breeds
diff --git a/source/user/examples/toy_model-dog_breeds.rst b/source/user/examples/toy_model-dog_breeds.rst
@@ -0,0 +1,2 @@
+Toy example: dog breed recognition
+==================================
diff --git a/source/user/index.rst b/source/user/index.rst
@@ -3,37 +3,34 @@ User documentation
 
 .. todo:: Documentation is being written at this moment.
 
+Quickstart
+----------
 
-User roles
-------------
-Brief description of the user roles and their relation with the usecases and the applications.
+If you want a quickstart guide, please check the following link.
 
 .. toctree::
    :maxdepth: 1
 
-   user_roles/role1.rst
-   user_roles/role2.rst
-   user_roles/role3.rst
+   quickstart
 
+Overview
+---------
 
-Catalogue of modules
-------------
+A more in depth documentation, with detailed description on the archicture and
+components is provided in the following sections.
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
 
-   catalogue/image_classification.rst
+   overview/index
 
+Examples
+--------
 
-Use cases
-------------
+The following sections provide information on how several deep learning models
+have been developed and integrated with our platform.
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
 
-   usecases/plants.rst
-   usecases/satellites.rst
-   usecases/mods.rst
-   usecases/retinopathy.rst
-   usecases/lattice_qcd.rst
-   usecases/toy_model-dog_breeds.rst
+   examples/index
diff --git a/source/user/overview/api.rst b/source/user/overview/api.rst
@@ -0,0 +1,2 @@
+DEEPaaS API
+===========
diff --git a/source/user/overview/architecture.rst b/source/user/overview/architecture.rst
@@ -0,0 +1,2 @@
+Architecture overview
+---------------------
diff --git a/source/user/overview/cookiecutter.rst b/source/user/overview/cookiecutter.rst
@@ -0,0 +1,2 @@
+Repository template
+===================
diff --git a/source/user/overview/index.rst b/source/user/overview/index.rst
@@ -0,0 +1,11 @@
+Overview
+========
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+
+   architecture
+   cookiecutter
+   user-roles
+   api
diff --git a/source/user/overview/user-roles.rst b/source/user/overview/user-roles.rst
@@ -0,0 +1,2 @@
+Our different user roles
+========================
diff --git a/source/user/quickstart.rst b/source/user/quickstart.rst
@@ -0,0 +1,13 @@
+Quickstart guide
+----------------
+
+.. todo:: Provide information on (at least):
+
+   1. How to download and test a model (i.e. get docker, go to the marketplace, get the model, run it).
+
+   2. Use cookiecutter to develop a model
+
+   3. Integrate an existing model with DEEPaaS
+
+   4. Create a container from a model
+
diff --git a/source/user/usecases/lattice_qcd.rst b/source/user/usecases/lattice_qcd.rst
diff --git a/source/user/usecases/mods.rst b/source/user/usecases/mods.rst
diff --git a/source/user/usecases/plants.rst b/source/user/usecases/plants.rst
diff --git a/source/user/usecases/retinopathy.rst b/source/user/usecases/retinopathy.rst
diff --git a/source/user/usecases/satelites.rst b/source/user/usecases/satelites.rst
diff --git a/source/user/usecases/toy_model-dog_breeds.rst b/source/user/usecases/toy_model-dog_breeds.rst
diff --git a/source/user/user_roles/role1.rst b/source/user/user_roles/role1.rst
diff --git a/source/user/user_roles/role2.rst b/source/user/user_roles/role2.rst
diff --git a/source/user/user_roles/role3.rst b/source/user/user_roles/role3.rst