Applying Pike document structure

This change aligns the Mistral documents folder structure to
the one specified for Pike [1].
Documents were move to thir appropriate folder, but the different
guides do not follow their cookie cutted structure yet.
Install guide is in a separate change [2], while I could not
found the cookie cutter for the rest of the guides.

test-requirements.txt updated with the missing modules.

tox_install.sh modified to do not pass $MODULE_NAME and -e parameter to
edit-constraints.

[1]: http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html
[2]: https://review.openstack.org/#/c/476499/
[3]: https://etherpad.openstack.org/p/doc-migration-tracking

Change-Id: Ia1101fa2eada446d8eebfefa9bd15d8facd8b3b0
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Signed-off-by: csatari <gergely.csatari@nokia.com>

doc/README.md

@@ -1,24 +0,0 @@
-# Sphinx DOC hints
-
-## Migrating from OpenStack Wiki
-
-* Install pandoc
-* Copy wiki code into a file, e.g. `source.mw`
-* Convert to .rst
-
-  pandoc --from=mediawiki --to=rst --output=doc/source/dsl/dsl_v1.rst doc/source/dsl/source.mw
-
-* To make code samples fancy:
-
-  TODO: figure how to make YAML samples look nicer with `code::` directive
-
-## Using autodoc with sphinxcontrib.pecanwsme.rest and wsmeext.sphinxext plugins
-
-  TODO: why REST URL is not generated with parameters?
-
-## Running sphinx-autobuild
-
-[auto-loader](https://pypi.python.org/pypi/sphinx-autobuild/0.2.3) - rules for convenient development https://pypi.python.org/pypi/sphinx-autobuild/0.2.3. install, and run:
-
-  sphinx-autobuild doc/source doc/build
-

doc/source/README.rst

@@ -1 +0,0 @@
-.. include:: ../../README.rst

doc/source/admin/dsl_v2.rst

@@ -855,6 +855,7 @@ Input parameters:
 -  **password** - User password to to authenticate on the host. *Optional*.
 -  **private_key_filename** - Private key file name which will be used for
    authentication on remote host.
+
 All private keys should be on executor host in **<home-user-directory>/.ssh/**.
 **<home-user-directory>** should refer to user directory under which service is
 running. *Optional*.

doc/source/admin/index.rst

@@ -4,4 +4,5 @@ Mistral Workflow Language Specification
 .. toctree::
    :maxdepth: 1
 
+   upgrade_guide
    Mistral Workflow Language v2 <dsl_v2>

doc/source/index.rst

@@ -24,34 +24,41 @@ User guide
 **Installation**
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
 
-   guides/installation_guide
-   guides/configuration_guide
-   guides/dashboard_guide
-   guides/upgrade_guide
-   guides/mistralclient_guide
+   install/index
+   configuration/index
+   admin/upgrade_guide
 
 **API**
 
 .. toctree::
    :maxdepth: 2
 
-   developer/webapi/index
+   api/index
 
 **Mistral Workflow Language**
 
 .. toctree::
    :maxdepth: 2
 
-   dsl/index
+   admin/dsl_v2
 
 **CLI**
 
 .. toctree::
    :maxdepth: 1
 
-   guides/cli_guide
+   cli/index
+
+Admin guide
+-----------
+
+.. toctree::
+  :maxdepth: 1
+
+  admin/index
+
 
 Developer guide
 ---------------
@@ -59,11 +66,10 @@ Developer guide
 .. toctree::
    :maxdepth: 2
 
-   developer/index
+   contributor/index
 
 Indices and tables
 ==================
 
 * :ref:`genindex`
 * :ref:`search`
-

doc/source/install/dashboard_guide.rst

@@ -56,4 +56,4 @@ The following should get you started:
 
 Debug instructions
 ------------------
-Please refer to :doc:`Mistral Troubleshooting <../developer/troubleshooting>`
+Please refer to :doc:`Mistral Troubleshooting <../contributor/troubleshooting>`

doc/source/install/index.rst

@@ -0,0 +1,9 @@
+Mistral User Guide
+==================
+
+.. toctree::
+   :maxdepth: 1
+
+   installation_guide
+   dashboard_guide
+   mistralclient_guide

doc/source/install/installation_guide.rst

@@ -31,7 +31,7 @@ sure **Keystone v3** is installed.
 Installation
 ------------
 
-**NOTE**: If it is needed to install Mistral using devstack, please refer to :doc:`Mistral Devstack Installation </developer/devstack>`
+**NOTE**: If it is needed to install Mistral using devstack, please refer to :doc:`Mistral Devstack Installation </contributor/devstack>`
 
 First of all, clone the repo and go to the repo directory::
 
@@ -45,7 +45,7 @@ Generate config::
 Configure Mistral as needed. The configuration file is located in
 ``etc/mistral.conf.sample``. You will need to modify the configuration options
 and then copy it into ``/etc/mistral/mistral.conf``.
-For details see :doc:`Mistral Configuration Guide </guides/configuration_guide>`
+For details see :doc:`Mistral Configuration Guide </configuration/index>`
 
 **Virtualenv installation**::
 
@@ -91,7 +91,7 @@ workflows which Mistral provides for all Mistral users.::
 
     $ mistral-db-manage --config-file <path-to-mistral.conf> populate
 
-For more detailed information about *mistral-db-manage* script please see :doc:`Mistral Upgrade Guide </guides/upgrade_guide>`.
+For more detailed information about *mistral-db-manage* script please see :doc:`Mistral Upgrade Guide </admin/upgrade_guide>`.
 
 **NOTE**: For users who want a dry run with **SQLite** database backend(not
 used in production), *mistral-db-manage* is not recommended for database
@@ -174,4 +174,4 @@ then put customized mistral.conf to '<user-defined-directory>'.
 Mistral Client Installation
 ---------------------------
 
-Please refer to :doc:`Mistral Client / CLI Guide </guides/mistralclient_guide>`
+Please refer to :doc:`Mistral Client / CLI Guide <../cli/index>`

doc/source/install/mistralclient_guide.rst

@@ -76,7 +76,7 @@ Targeting non-preconfigured clouds
 
 Mistral is capable of executing workflows on external OpenStack clouds,
 different from the one defined in the `mistral.conf` file in the
-`keystone_authtoken` section. (More detail in the :doc:`configuration_guide`).
+`keystone_authtoken` section. (More detail in the :doc:`/configuration/index`).
 
 For example, if the mistral server is configured to authenticate with the
 `http://keystone1.example.com` cloud and the user wants to execute the workflow

doc/source/quickstart.rst

@@ -10,12 +10,12 @@ three prerequisites.
 Install and run Mistral
 ~~~~~~~~~~~~~~~~~~~~~~~
 
-Go through the installation manual: :doc:`Mistral Installation Guide </guides/installation_guide>`
+Go through the installation manual: :doc:`Mistral Installation Guide <install/index>`
 
 Install Mistral client
 ~~~~~~~~~~~~~~~~~~~~~~
 
-To install mistralclient, please refer to :doc:`Mistral Client / CLI Guide </guides/mistralclient_guide>`
+To install mistralclient, please refer to :doc:`Mistral Client / CLI Guide <cli/index>`
 
 Export Keystone credentials
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -62,7 +62,7 @@ This simple workflow iterates through a list of names in ``task1`` (using
 then stores the word "Done" as a result of the second task (`task2`).
 
 To learn more about the Mistral Workflows and what you can do, read the
-:doc:`Mistral Workflow Language specification </dsl/dsl_v2>`
+:doc:`Mistral Workflow Language specification <admin/dsl_v2>`
 
 Upload the workflow
 -------------------

doc/source/terminology/actions.rst

@@ -19,7 +19,7 @@ its state and result.
 
 .. image:: /img/Mistral_actions.png
 
-:doc:`How to work with asynchronous actions </developer/asynchronous_actions>`
+:doc:`How to work with asynchronous actions </contributor/asynchronous_actions>`
 
 System actions
 --------------
@@ -27,7 +27,7 @@ System actions
 System actions are provided by Mistral out of the box and are available to all
 users. Additional actions can be added via the custom action plugin mechanism.
 
-:doc:`How to write an Action Plugin </developer/creating_custom_action>`
+:doc:`How to write an Action Plugin </contributor/creating_custom_action>`
 
 
 Ad-hoc actions

doc/source/terminology/workbooks.rst

@@ -80,4 +80,4 @@ the original workbook.
 * **actions** - Dictionary containing ad-hoc action definitions. *Optional*.
 
 For more details about Mistral Workflow Language itself, please see
-:doc:`Mistral Workflow Language specification </dsl/index>`
+:doc:`Mistral Workflow Language specification </admin/dsl_v2>`

doc/source/terminology/workflows.rst

@@ -137,4 +137,4 @@ YAML example
           requires: [create_vm, associate_ip]
 
 For more details about Mistral Workflow Language itself, please see
-:doc:`Mistral Workflow Language specification </dsl/index>`
+:doc:`Mistral Workflow Language specification </admin/dsl_v2>`

test-requirements.txt

@@ -2,20 +2,32 @@
 # of appearance. Changing the order has an impact on the overall integration
 # process, which may cause wedges in the gate later.
 coverage!=4.4,>=4.0 # Apache-2.0
+croniter>=0.3.4 # MIT License
+eventlet!=0.18.3,>=0.18.2,!=0.20.1,<0.21.0 # MIT
 fixtures>=3.0.0 # Apache-2.0/BSD
 hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0
+keystonemiddleware>=4.12.0 # Apache-2.0
+mistral-lib>=0.2.0 # Apache-2.0
+mock>=2.0 # BSD
+networkx>=1.10 # BSD
 nose # LGPL
 oslotest>=1.10.0 # Apache-2.0
+oslo.db>=4.23.0 # Apache-2.0
+oslo.messaging>=5.24.2,!=5.25.0 # Apache-2.0
+oslo.policy>=1.23.0 # Apache-2.0
+osprofiler>=1.4.0 # Apache-2.0
 os-api-ref>=1.0.0 # Apache-2.0
+pecan>=1.0.0,!=1.0.2,!=1.0.3,!=1.0.4,!=1.2 # BSD
 pyflakes==0.8.1 # MIT
-mock>=2.0 # BSD
+reno!=2.3.1,>=1.8.0 # Apache-2.0
 requests-mock>=1.1 # Apache-2.0
 sphinx>=1.6.2 # BSD
 sphinxcontrib-httpdomain # BSD
 sphinxcontrib-pecanwsme>=0.8 # Apache-2.0
 openstackdocstheme>=1.11.0 # Apache-2.0
+tooz>=1.47.0 # Apache-2.0
 tempest>=14.0.0 # Apache-2.0
 testrepository>=0.0.18 # Apache-2.0/BSD
 testtools>=1.4.0 # MIT
 unittest2 # BSD
-reno!=2.3.1,>=1.8.0 # Apache-2.0
+WSME>=0.8 # MIT

tools/tox_install.sh

@@ -50,7 +50,8 @@ fi
 # This is the main purpose of the script: Allow local installation of
 # the current repo. It is listed in constraints file and thus any
 # install will be constrained and we need to unconstrain it.
-edit-constraints $localfile -- $MODULE_NAME "-e file://$PWD#egg=$MODULE_NAME"
+#edit-constraints $localfile -- $MODULE_NAME "-e file://$PWD#egg=$MODULE_NAME"
+edit-constraints $localfile -- --
 
 $install_cmd -U $*
 exit $?