Merge branch 'feature/split_docs' into develop

roadiz · Jul 7, 2015 · 99684e2 · 99684e2
2 parents 919509c + 8b69fa0
commit 99684e2
Show file tree

Hide file tree

Showing 49 changed files with 128 additions and 73 deletions.
diff --git a/intro/contributing.rst → developer/first-steps/contributing.rst b/intro/contributing.rst → developer/first-steps/contributing.rst
diff --git a/intro/getting_started.rst → developer/first-steps/getting_started.rst b/intro/getting_started.rst → developer/first-steps/getting_started.rst
diff --git a/developer/first-steps/index.rst b/developer/first-steps/index.rst
@@ -0,0 +1,12 @@
+===========
+First steps
+===========
+
+.. toctree::
+   :maxdepth: 2
+
+   getting_started
+   manual_config
+   upgrading
+   moving
+   contributing
diff --git a/intro/manual_config.rst → developer/first-steps/manual_config.rst b/intro/manual_config.rst → developer/first-steps/manual_config.rst
diff --git a/intro/moving.rst → developer/first-steps/moving.rst b/intro/moving.rst → developer/first-steps/moving.rst
diff --git a/intro/upgrading.rst → developer/first-steps/upgrading.rst b/intro/upgrading.rst → developer/first-steps/upgrading.rst
diff --git a/forms/contact_forms.rst → developer/forms/contact_forms.rst b/forms/contact_forms.rst → developer/forms/contact_forms.rst
diff --git a/forms/custom_forms.rst → developer/forms/custom_forms.rst b/forms/custom_forms.rst → developer/forms/custom_forms.rst
diff --git a/forms/img/custom-form.pdf → developer/forms/img/custom-form.pdf b/forms/img/custom-form.pdf → developer/forms/img/custom-form.pdf
diff --git a/forms/img/custom-form.svg → developer/forms/img/custom-form.svg b/forms/img/custom-form.svg → developer/forms/img/custom-form.svg
diff --git a/forms/img/custom-form.xml → developer/forms/img/custom-form.xml b/forms/img/custom-form.xml → developer/forms/img/custom-form.xml
diff --git a/developer/forms/index.rst b/developer/forms/index.rst
@@ -0,0 +1,9 @@
+=====
+Forms
+=====
+
+.. toctree::
+   :maxdepth: 2
+
+   contact_forms
+   custom_forms
diff --git a/developer/index.rst b/developer/index.rst
@@ -0,0 +1,14 @@
+=======================
+Developer documentation
+=======================
+
+
+.. toctree::
+   :maxdepth: 2
+
+   first-steps/index.rst
+   nodes-system/index.rst
+   tags-system/index.rst
+   themes/index.rst
+   forms/index.rst
+   services/index.rst
diff --git a/nodes-system/img/NSPage-php.pdf → developer/nodes-system/img/NSPage-php.pdf b/nodes-system/img/NSPage-php.pdf → developer/nodes-system/img/NSPage-php.pdf
diff --git a/nodes-system/img/NSPage-php.svg → developer/nodes-system/img/NSPage-php.svg b/nodes-system/img/NSPage-php.svg → developer/nodes-system/img/NSPage-php.svg
diff --git a/nodes-system/img/NSPage-php.xml → developer/nodes-system/img/NSPage-php.xml b/nodes-system/img/NSPage-php.xml → developer/nodes-system/img/NSPage-php.xml
diff --git a/nodes-system/img/NSPage-schema.pdf → developer/nodes-system/img/NSPage-schema.pdf b/nodes-system/img/NSPage-schema.pdf → developer/nodes-system/img/NSPage-schema.pdf
diff --git a/nodes-system/img/NSPage-schema.svg → developer/nodes-system/img/NSPage-schema.svg b/nodes-system/img/NSPage-schema.svg → developer/nodes-system/img/NSPage-schema.svg
diff --git a/nodes-system/img/NSPage-schema.xml → developer/nodes-system/img/NSPage-schema.xml b/nodes-system/img/NSPage-schema.xml → developer/nodes-system/img/NSPage-schema.xml
diff --git a/nodes-system/img/node-struct.pdf → developer/nodes-system/img/node-struct.pdf b/nodes-system/img/node-struct.pdf → developer/nodes-system/img/node-struct.pdf
diff --git a/nodes-system/img/node-struct.svg → developer/nodes-system/img/node-struct.svg b/nodes-system/img/node-struct.svg → developer/nodes-system/img/node-struct.svg
diff --git a/nodes-system/img/node-struct.xml → developer/nodes-system/img/node-struct.xml b/nodes-system/img/node-struct.xml → developer/nodes-system/img/node-struct.xml
diff --git a/developer/nodes-system/index.rst b/developer/nodes-system/index.rst
@@ -0,0 +1,11 @@
+===========
+Node system
+===========
+
+.. toctree::
+   :maxdepth: 2
+
+   intro
+   node_type_fields
+   nodes
+   nodes_sources
diff --git a/nodes-system/intro.rst → developer/nodes-system/intro.rst b/nodes-system/intro.rst → developer/nodes-system/intro.rst
diff --git a/nodes-system/node_type_fields.rst → developer/nodes-system/node_type_fields.rst b/nodes-system/node_type_fields.rst → developer/nodes-system/node_type_fields.rst
diff --git a/nodes-system/nodes.rst → developer/nodes-system/nodes.rst b/nodes-system/nodes.rst → developer/nodes-system/nodes.rst
diff --git a/nodes-system/nodes_sources.rst → developer/nodes-system/nodes_sources.rst b/nodes-system/nodes_sources.rst → developer/nodes-system/nodes_sources.rst
diff --git a/services/intro.rst → developer/services/index.rst b/services/intro.rst → developer/services/index.rst
@@ -1,7 +1,7 @@
 .. _services:
 
-Using Roadiz services
-=====================
+Services
+========
 
 Roadiz is built upon `Pimple <http://pimple.sensiolabs.org>`_ dependency injection container.
 Thanks to this architecture, all Core and Backoffice services are available from any controller

diff --git a/developer/tags-system/index.rst b/developer/tags-system/index.rst
@@ -0,0 +1,8 @@
+==========
+Tag system
+==========
+
+.. toctree::
+   :maxdepth: 2
+
+   intro
diff --git a/tags-system/intro.rst → developer/tags-system/intro.rst b/tags-system/intro.rst → developer/tags-system/intro.rst
diff --git a/tags-system/tag-translations.pdf → developer/tags-system/tag-translations.pdf b/tags-system/tag-translations.pdf → developer/tags-system/tag-translations.pdf
diff --git a/tags-system/tag-translations.svg → developer/tags-system/tag-translations.svg b/tags-system/tag-translations.svg → developer/tags-system/tag-translations.svg
diff --git a/tags-system/tag-translations.xml → developer/tags-system/tag-translations.xml b/tags-system/tag-translations.xml → developer/tags-system/tag-translations.xml
diff --git a/tags-system/tags.pdf → developer/tags-system/tags.pdf b/tags-system/tags.pdf → developer/tags-system/tags.pdf
diff --git a/tags-system/tags.rst → developer/tags-system/tags.rst b/tags-system/tags.rst → developer/tags-system/tags.rst
diff --git a/tags-system/tags.svg → developer/tags-system/tags.svg b/tags-system/tags.svg → developer/tags-system/tags.svg
diff --git a/tags-system/tags.xml → developer/tags-system/tags.xml b/tags-system/tags.xml → developer/tags-system/tags.xml
diff --git a/themes/create_theme.rst → developer/themes/create_theme.rst b/themes/create_theme.rst → developer/themes/create_theme.rst
diff --git a/themes/custom_assignations.rst → developer/themes/custom_assignations.rst b/themes/custom_assignations.rst → developer/themes/custom_assignations.rst
diff --git a/developer/themes/index.rst b/developer/themes/index.rst
@@ -0,0 +1,10 @@
+======
+Themes
+======
+
+.. toctree::
+   :maxdepth: 2
+
+   create_theme
+   using_twig
+   custom_assignations
diff --git a/themes/using_twig.rst → developer/themes/using_twig.rst b/themes/using_twig.rst → developer/themes/using_twig.rst
diff --git a/translation/intro.rst → developer/translation/intro.rst b/translation/intro.rst → developer/translation/intro.rst
diff --git a/roadiz-events/intro.rst → extension/events/intro.rst b/roadiz-events/intro.rst → extension/events/intro.rst
@@ -1,7 +1,7 @@
 .. _events:
 
-Using Roadiz events
-===================
+Events
+======
 
 Roadiz node system implements several events. So you will be able to create
 and inject your own event subscribers inside *Roadiz* dispatcher.
@@ -11,7 +11,7 @@ To understand how the event dispatcher works, you should read the
 
 
 Nodes events
------------
+------------
 
 ``RZ\Roadiz\Core\Events\NodeEvents``
 
@@ -20,6 +20,8 @@ Nodes events
 * *node.deleted:* ``NodeEvents::NODE_DELETED``
 * *node.undeleted:* ``NodeEvents::NODE_UNDELETED``
 * *node.tagged:* ``NodeEvents::NODE_TAGGED`` This event is triggered for tag and un-tag action.
+* *node.visibilityChanged:* ``NodeEvents::NODE_VISIBILITY_CHANGED`` This event is triggered each time a node becomes visible or unvisible.
+* *node.statusChanged:* ``NodeEvents::NODE_STATUS_CHANGED`` This event is triggered each time a node status changes.
 
 Every node events methods will accept a ``RZ\Roadiz\Core\Events\FilterNodeEvent`` object as argument.
 This object contains the current ``Node`` entity. You will get it using ``$event->getNode()``.
@@ -51,3 +53,27 @@ Tags events
 
 Every tag events methods will accept a ``RZ\Roadiz\Core\Events\FilterTagEvent`` object as argument.
 This object contains the current ``Tag`` entity. You will get it using ``$event->getTag()``.
+
+Translations events
+-------------------
+
+``RZ\Roadiz\Core\Events\TranslationEvents``
+
+* *translation.created:* ``TranslationEvents::TRANSLATION_CREATED``
+* *translation.updated:* ``TranslationEvents::TRANSLATION_UPDATED``
+* *translation.deleted:* ``TranslationEvents::TRANSLATION_DELETED``
+
+Every tag events methods will accept a ``RZ\Roadiz\Core\Events\FilterTranslationEvent`` object as argument.
+This object contains the current ``Translation`` entity. You will get it using ``$event->getTranslation()``.
+
+UrlAlias events
+-------------------
+
+``RZ\Roadiz\Core\Events\UrlAliasEvents``
+
+* *urlAlias.created:* ``UrlAliasEvents::URL_ALIAS_CREATED``
+* *urlAlias.updated:* ``UrlAliasEvents::URL_ALIAS_UPDATED``
+* *urlAlias.deleted:* ``UrlAliasEvents::URL_ALIAS_UPDATED``
+
+Every tag events methods will accept a ``RZ\Roadiz\Core\Events\FilterUrlAliasEvent`` object as argument.
+This object contains the current ``UrlAlias`` entity. You will get it using ``$event->getUrlAlias()``.
diff --git a/themes/extending_roadiz.rst → extension/extending_roadiz.rst b/themes/extending_roadiz.rst → extension/extending_roadiz.rst
diff --git a/extension/index.rst b/extension/index.rst
@@ -0,0 +1,9 @@
+================
+Extension system
+================
+
+.. toctree::
+   :maxdepth: 2
+
+   extending_roadiz
+   events/intro
diff --git a/index.rst b/index.rst
@@ -7,85 +7,26 @@ Welcome to Roadiz's documentation!
 Roadiz is a polymorphic CMS based on a node system which can handle many types of services.
 It’s based on *Symfony* components and *Doctrine ORM* for maximum performances and security.
 
-First contact
--------------
+User documentation
+------------------
 
 .. toctree::
    :maxdepth: 2
 
-   intro/getting_started
-   intro/manual_config
-   intro/upgrading
-   intro/moving
-   intro/contributing
+   user/index.rst
 
-Node system
------------
+Developer documentation
+-----------------------
 
 .. toctree::
    :maxdepth: 2
 
-   nodes-system/intro
-   nodes-system/node_type_fields
+   developer/index.rst
 
-Tag system
-----------
+Extension documentation
+-----------------------
 
 .. toctree::
    :maxdepth: 2
 
-   tags-system/intro
-
-
-User system
------------
-
-.. toctree::
-   :maxdepth: 2
-
-   users/intro
-
-
-Themes
-------
-
-.. toctree::
-   :maxdepth: 2
-
-   themes/create_theme
-   themes/using_twig
-   themes/custom_assignations
-
-Forms
------
-
-.. toctree::
-   :maxdepth: 2
-
-   forms/contact_forms
-   forms/custom_forms
-
-Services
---------
-
-.. toctree::
-   :maxdepth: 2
-
-   services/intro
-
-Extension system
-----------------
-
-.. toctree::
-   :maxdepth: 2
-
-   themes/extending_roadiz
-   roadiz-events/intro
-
-
-
-.. Indices and tables
-.. ==================
-
-.. * :ref:`genindex`
-.. * :ref:`search`
+   extension/index.rst
diff --git a/documents/intro.rst → user/documents/intro.rst b/documents/intro.rst → user/documents/intro.rst
diff --git a/user/index.rst b/user/index.rst
@@ -0,0 +1,15 @@
+==================
+User documentation
+==================
+
+**User documentation is not available yet.**
+We invite you to us questions on our `Gitter account <https://gitter.im/roadiz/roadiz>`_ or
+to leave some documentation suggestions on our `Github repository <https://github.com/roadiz/docs/issues>`_.
+
+User system
+-----------
+
+.. toctree::
+   :maxdepth: 2
+
+   users/intro
diff --git a/users/intro.rst → user/users/intro.rst b/users/intro.rst → user/users/intro.rst