Merge pull request #160 from simphony/add-doc-troubleshooting

Added troubleshoot page in documentation
simphony · Jul 26, 2016 · 9af58e4 · 9af58e4
2 parents bd0395a + 28bfaa8
commit 9af58e4
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 0 deletions.
diff --git a/doc/source/deployment.rst b/doc/source/deployment.rst
@@ -54,6 +54,7 @@ Compatible docker containers can be found in DockerHub. Refer to the documentati
 of `simphony-remote-docker <https://github.com/simphony/simphony-remote-docker>`_
 repository to deploy the images.
 
+.. _deploy_setup_db:
 
 Setup Database Accounting
 -------------------------

diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -22,3 +22,4 @@ Key provided features:
    design
    developer
    api
+   troubleshooting
diff --git a/doc/source/troubleshoot/database.rst b/doc/source/troubleshoot/database.rst
@@ -0,0 +1,6 @@
+The database is not initalised properly
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Each user's server requires a database setup and readable by the local process on which the :py:mod:`remoteappmanager` web application is started.  The error message indicates that the database is not readable (e.g. it does not exist).  Please refer to :ref:`deploy_setup_db` for details and options on setting up the database.
+
+For more details on how the local process is managed, please refers to :py:mod:`remoteappmanager.spawner`.
diff --git a/doc/source/troubleshooting.rst b/doc/source/troubleshooting.rst
@@ -0,0 +1,5 @@
+Troubleshoot
+------------
+
+.. include::
+    troubleshoot/database.rst