From 67bc131a17c71433414deeead13ec8173deee6c5 Mon Sep 17 00:00:00 2001 From: Kit Yan Choi Date: Mon, 25 Jul 2016 13:47:16 +0100 Subject: [PATCH 1/4] added troubleshoot page in doc --- doc/source/deployment.rst | 1 + doc/source/index.rst | 1 + doc/source/troubleshoot/database_not_readable.rst | 6 ++++++ doc/source/troubleshooting.rst | 5 +++++ 4 files changed, 13 insertions(+) create mode 100644 doc/source/troubleshoot/database_not_readable.rst create mode 100644 doc/source/troubleshooting.rst diff --git a/doc/source/deployment.rst b/doc/source/deployment.rst index cafa680a0..916e9fb50 100644 --- 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 `_ repository to deploy the images. +.. _deploy_setup_db: Setup Database Accounting ------------------------- diff --git a/doc/source/index.rst b/doc/source/index.rst index 8e3e3953d..ef9deb726 100644 --- 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_not_readable.rst b/doc/source/troubleshoot/database_not_readable.rst new file mode 100644 index 000000000..8817ad1f0 --- /dev/null +++ b/doc/source/troubleshoot/database_not_readable.rst @@ -0,0 +1,6 @@ +500 Internal Server Error: Sqlite database is not readable +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +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 new file mode 100644 index 000000000..389775a08 --- /dev/null +++ b/doc/source/troubleshooting.rst @@ -0,0 +1,5 @@ +Troubleshoot +------------ + +.. include:: + troubleshoot/database_not_readable.rst From c25f8388ed4c98feaa447bb4941d23ac4be72e65 Mon Sep 17 00:00:00 2001 From: Kit Yan Choi Date: Tue, 26 Jul 2016 12:37:04 +0100 Subject: [PATCH 2/4] updated title for an issue in troubleshoot --- doc/source/troubleshoot/database_not_readable.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/source/troubleshoot/database_not_readable.rst b/doc/source/troubleshoot/database_not_readable.rst index 8817ad1f0..0d72941d3 100644 --- a/doc/source/troubleshoot/database_not_readable.rst +++ b/doc/source/troubleshoot/database_not_readable.rst @@ -1,5 +1,5 @@ -500 Internal Server Error: Sqlite database is not readable -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +The database is not initalised +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 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. From aa7e045d7a97fb5dcc1b1c67a9077da74dbcd2e3 Mon Sep 17 00:00:00 2001 From: Kit Yan Choi Date: Tue, 26 Jul 2016 12:37:48 +0100 Subject: [PATCH 3/4] Rename --- .../troubleshoot/{database_not_readable.rst => database.rst} | 0 doc/source/troubleshooting.rst | 2 +- 2 files changed, 1 insertion(+), 1 deletion(-) rename doc/source/troubleshoot/{database_not_readable.rst => database.rst} (100%) diff --git a/doc/source/troubleshoot/database_not_readable.rst b/doc/source/troubleshoot/database.rst similarity index 100% rename from doc/source/troubleshoot/database_not_readable.rst rename to doc/source/troubleshoot/database.rst diff --git a/doc/source/troubleshooting.rst b/doc/source/troubleshooting.rst index 389775a08..fa21f4d52 100644 --- a/doc/source/troubleshooting.rst +++ b/doc/source/troubleshooting.rst @@ -2,4 +2,4 @@ Troubleshoot ------------ .. include:: - troubleshoot/database_not_readable.rst + troubleshoot/database.rst From 28bfaa81ac148fceae77d874008e65f6bcd148b6 Mon Sep 17 00:00:00 2001 From: Kit Yan Choi Date: Tue, 26 Jul 2016 12:39:07 +0100 Subject: [PATCH 4/4] update title again --- doc/source/troubleshoot/database.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/source/troubleshoot/database.rst b/doc/source/troubleshoot/database.rst index 0d72941d3..d2a2317d5 100644 --- a/doc/source/troubleshoot/database.rst +++ b/doc/source/troubleshoot/database.rst @@ -1,5 +1,5 @@ -The database is not initalised -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +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.