DOC Remove too complex engine installation instructions

FreeDiscovery · Sep 28, 2017 · 26c02a9 · 26c02a9
1 parent 42e17bd
commit 26c02a9
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 68 deletions.
diff --git a/doc/engine/deployment.md b/doc/engine/deployment.md
@@ -24,7 +24,7 @@ The easiest way of running FreeDiscovery as a background service on Linux / MacO
  3. Configure supervisor to launch FreeDiscovery by adding creating a new service definition file `/etc/supervisor/conf.d/freediscovery.conf`
     ```
     [program:freediscovery]
-    command=<freediscovery_excutable_path> run --cache-dir /srv/freediscovery_shared/ -y --hostname 0.0.0.0 -p 8888 --log-file /var/log/freediscovery/freediscovery.backend.log
+    command=<freediscovery_excutable_path> run --cache-dir /srv/freediscovery_shared/ -y --hostname 0.0.0.0 -p 5001 --log-file /var/log/freediscovery/freediscovery.backend.log
     directory=/
     autostart=true
     autorestart=true

diff --git a/doc/engine/index.rst b/doc/engine/index.rst
@@ -1,7 +1,6 @@
 FreeDiscovery Engine
 ====================
 
-**Installation**
 
 FreeDiscovery requires **Python 3.5+** and can be installed with `conda <https://conda.io/>`_,
 
@@ -11,21 +10,23 @@ FreeDiscovery requires **Python 3.5+** and can be installed with `conda <https:/
     conda install freediscovery
 
 
-**Running the server**
+The server can be started with
 
 * ``freediscovery run``
-* to check that the server started successfully, ``curl -X GET http://localhost:5001/``
 
+to check that the is successfully runnining, open ``http://localhost:5001/``.
 
 
+Contents
+^^^^^^^^
+
 .. toctree::
    :maxdepth: 2
 
    overview
-   installation_instructions
    quickstart
    examples/index
-   cli
    data_ingestion
+   cli
    deployment
    API <../openapi-docs/index.html#http://>
diff --git a/doc/engine/installation_instructions.md b/doc/engine/installation_instructions.md
diff --git a/doc/user_manual/index.rst b/doc/user_manual/index.rst
@@ -6,4 +6,6 @@ User Manual
 
    tf-idf
    scaling_benchmarks
+
+