diff -r 78f842f992a0 -r 5798c437f5ca src/source/index.rst --- a/src/source/index.rst Mon Mar 26 11:12:28 2018 +0200 +++ b/src/source/index.rst Mon Mar 26 17:29:25 2018 +0200 @@ -6,65 +6,20 @@ .. _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: - -* 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`! - +Contents +--------- .. toctree:: :maxdepth: 2 - quickstart - architecture - install - config - manage - extend - - -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. + Introduction + Quickstart + Installing + Configuration + User’s Guide + Developer’s Guide + Application architecture PyAMS external packages