Updated Doc and architecture diagrams dev-dc
authorDamien Correia
Wed, 28 Mar 2018 18:07:02 +0200
branchdev-dc
changeset 32 fd15bdd3192e
parent 31 d8f323bf5c7e
child 33 eeef4052fcd1
Updated Doc and architecture diagrams
src/source/_static/architecture.png
src/source/_static/architecture_dev.png
src/source/_static/architecture_prod.png
src/source/_static/architecture_quickstart.png
src/source/admin.rst
src/source/appinstall.rst
src/source/architecture.rst
src/source/index.rst
src/source/install.rst
Binary file src/source/_static/architecture.png has changed
Binary file src/source/_static/architecture_dev.png has changed
Binary file src/source/_static/architecture_prod.png has changed
Binary file src/source/_static/architecture_quickstart.png has changed
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/source/admin.rst	Wed Mar 28 18:07:02 2018 +0200
@@ -0,0 +1,11 @@
+.. _admin:
+
+
+Admin's Guide
+================
+
+.. toctree::
+    :maxdepth: 2
+
+    Installation <install>
+    Settings <config>
--- a/src/source/appinstall.rst	Mon Mar 26 17:48:15 2018 +0200
+++ b/src/source/appinstall.rst	Wed Mar 28 18:07:02 2018 +0200
@@ -248,7 +248,7 @@
 NLTK initialization
 -------------------
 
-Some NLTK (Natural Language Toolkit) tokenizers and stopwords utilities are used to index fulltext contents elements. 
+Some NLTK (Natural Language Toolkit) tokenizers and stopwords utilities are used to index fulltext contents elements.
 This package requires downloading and configuration of several elements which are done as follow:
 
 .. code-block:: bash
--- a/src/source/architecture.rst	Mon Mar 26 17:48:15 2018 +0200
+++ b/src/source/architecture.rst	Wed Mar 28 18:07:02 2018 +0200
@@ -4,18 +4,38 @@
 ==============================
 
 PyAMS applications are built on a small set of prerequisites and external components which *can* or, for some of them,
-*must* be included. Some of them are:
+*must* be included, the minimal configuration is:
 
 * a mandatory shared ZODB;  :ref:`zodb` chapter
 
 * a Redis or Memcached server, to handle cache and sessions;
-    :ref:`pyams_cache` chapter
+  :ref:`pyams_cache` chapter
+
+
+Quickstart deployment
+---------------------
+
+
 
-* a websockets server (GuniCorn), used to handle desktop notifications; you can find information about this component in the
-  :ref:`pyams_notify` chapter;
+.. image:: _static/architecture_quickstart.png
+
+
+
+Developpement deployment
+------------------------
+
+* a websockets server (GuniCorn), used to handle desktop notifications;
+  you can find information about this component in the :ref:`pyams_notify` chapter;
 
 * an Elasticsearch index, used to handle quick and optimized searching.
 
 
-.. image:: _static/architecture.png
+.. image:: _static/architecture_dev.png
+
 
+Production deployment
+---------------------
+
+
+.. image:: _static/architecture_prod.png
+
--- a/src/source/index.rst	Mon Mar 26 17:48:15 2018 +0200
+++ b/src/source/index.rst	Wed Mar 28 18:07:02 2018 +0200
@@ -15,12 +15,10 @@
 
    Introduction <introduction>
    Quickstart <quickstart>
-   Installing <install>
-   Configuration <config>
+   Application architecture <architecture>
+   Admin's Guide <admin>
    User’s Guide <manage>
    Developer’s Guide <extend>
-   Application architecture <architecture>
-
 
 PyAMS external packages
 -----------------------
--- a/src/source/install.rst	Mon Mar 26 17:48:15 2018 +0200
+++ b/src/source/install.rst	Wed Mar 28 18:07:02 2018 +0200
@@ -8,3 +8,4 @@
 
    zodb
    appinstall
+