# HG changeset patch # User Damien Correia # Date 1522253222 -7200 # Node ID fd15bdd3192ec1f7ed2c988cf8ea78a41ae07fde # Parent d8f323bf5c7ed97614adcb338309df422a6e1728 Updated Doc and architecture diagrams diff -r d8f323bf5c7e -r fd15bdd3192e src/source/_static/architecture.png Binary file src/source/_static/architecture.png has changed diff -r d8f323bf5c7e -r fd15bdd3192e src/source/_static/architecture_dev.png Binary file src/source/_static/architecture_dev.png has changed diff -r d8f323bf5c7e -r fd15bdd3192e src/source/_static/architecture_prod.png Binary file src/source/_static/architecture_prod.png has changed diff -r d8f323bf5c7e -r fd15bdd3192e src/source/_static/architecture_quickstart.png Binary file src/source/_static/architecture_quickstart.png has changed diff -r d8f323bf5c7e -r fd15bdd3192e src/source/admin.rst --- /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 + Settings diff -r d8f323bf5c7e -r fd15bdd3192e src/source/appinstall.rst --- 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 diff -r d8f323bf5c7e -r fd15bdd3192e src/source/architecture.rst --- 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 + diff -r d8f323bf5c7e -r fd15bdd3192e src/source/index.rst --- 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 Quickstart - Installing - Configuration + Application architecture + Admin's Guide User’s Guide Developer’s Guide - Application architecture - PyAMS external packages ----------------------- diff -r d8f323bf5c7e -r fd15bdd3192e src/source/install.rst --- 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 +