src/source/index.rst
changeset 46 5fe8d5ffccde
parent 41 9379f4e44a5a
child 50 6ed429390935
--- a/src/source/index.rst	Mon Mar 26 10:38:06 2018 +0200
+++ b/src/source/index.rst	Thu Apr 12 11:18:48 2018 +0200
@@ -6,65 +6,38 @@
 .. _index:
 
 
-**WARNING**: this is a "work-in-progress" documentation. All elements described here are not publicly available yet!!!
-
-
-Welcome to PyAMS's documentation!
-=================================
-
-At first, PyAMS was "Pyramid Application Management Skin". Actually, it's not only a simple skin but a whole "Suite" of
-applications and content management tools.
-
-PyAMS is built on top of MyAMS (My Application Management Skin), a small web client framework built on top of JQuery
-and Bootstrap, which was developed by the french national forestry office (ONF -- Office national des forêts --
-http://www.onf.fr) to build web applications in several languages (actually java, Python and PHP). The new ONF website
-is now completely handled with PyAMS framework.
 
-PyAMS is a multipurpose set of packages, providing tools including:
+Contents
+---------
 
-* custom interfaces
-* custom registry annotations
-* custom security policy
-* local registry support
-* network protocols utilities (for HTTP and XML-RPC)
-* command line scripts
-* custom utilities.
-
-*PyAMS_content* is an important package providing content management features, which can be easily extended to manage
-your own content types. But PyAMS can also be used to manage any kind of application.
-
-If you just want to know how easy it is to create a PyAMS application instance, just read the :ref:`quickstart`!
-
-To know how PyAMS management interface looks like, look at :ref:`screenshots`!
 
 
 .. toctree::
    :maxdepth: 2
+   :caption: Getting started
 
-   quickstart
-   architecture
-   install
-   config
-   manage
-   extend
+   Introduction <introduction>
+   Application architecture <architecture>
+   Quickstart <quickstart>
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Tutorial
+
+   User’s Guide <manage>
+   screenshots
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Custom install documentation
+
+   ZODB Server <zodb>
+   PyAMS Installation <install>
+   PyAMS Configuration <config>
+   site
+   scripts
 
 
-PyAMS applications architecture
--------------------------------
-
-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:
-
-* a mandatory shared ZODB;
-
-* a Redis or Memcached server, to handle cache and sessions;
-
-* a websockets server, 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.
-
-See :ref:`architecture` to get all architecture details.
 
 
 PyAMS external packages
@@ -72,59 +45,14 @@
 
 PyAMS is built on many external packages, and provides a whole set of extensions. Here is a list of them:
 
-* pyams_template (:ref:`pyams_template`)
-
-* pyams_viewlet (:ref:`pyams_viewlet`)
-
-* pyams_pagelet (:ref:`pyams_pagelet`)
-
-* pyams_utils (:ref:`pyams_utils`)
-
-* pyams_skin (:ref:`pyams_skin`)
-
-* pyams_form (:ref:`pyams_form`)
-
-* pyams_file (:ref:`pyams_file`)
-
-* pyams_i18n (:ref:`pyams_i18n`)
-
-* pyams_security (:ref:`pyams_security`)
-
-* pyams_zmi (:ref:`pyams_zmi`)
-
-* pyams_zodbbrowser (:ref:`pyams_zodbbrowser`)
-
-* pyams_catalog (:ref:`pyams_catalog`)
-
-* pyams_mail (:ref:`pyams_mail`)
 
-* pyams_ldap (:ref:`pyams_ldap`)
-
-* pyams_cache (:ref:`pyams_cache`)
-
-* pyams_alchemy (:ref:`pyams_alchemy`)
-
-* pyams_zmq (:ref:`pyams_zmq`)
-
-* pyams_scheduler (:ref:`pyams_scheduler`)
-
-* pyams_workflow (:ref:`pyams_workflow`)
-
-* pyams_thesaurus (:ref:`pyams_thesaurus`)
+.. toctree::
+   :maxdepth: 2
+   :caption:  API documentation
 
-* pyams_sequence (:ref:`pyams_sequence`)
-
-* pyams_portal (:ref:`pyams_portal`)
-
-* pyams_media (:ref:`pyams_media`)
+   extend
+   packages
 
-* pyams_notify (:ref:`pyams_notify`)
-
-* pyams_gis (:ref:`pyams_gis`)
-
-* pyams_content (:ref:`pyams_content`)
-
-* pyams_content_es (:ref:`pyams_content_es`)
 
 
 Indices and tables