Merge "Mistral documentation: Initial commit"

.gitignore

@@ -31,6 +31,7 @@ cover/*
 .testrepository/
 subunit.log
 .mistral.conf
+ChangeLog
 
 # Translations
 *.mo

doc/source/_templates/sidebarlinks.html

@@ -0,0 +1,11 @@
+<h3>Useful Links</h3>
+<ul>
+  <li><a href="https://launchpad.net/mistral">Mistral @ Launchpad</a></li>
+  <li><a href="https://wiki.openstack.org/wiki/mistral">Mistral @ OpenStack Wiki</a></li>
+</ul>
+
+{% if READTHEDOCS %}
+<script type='text/javascript'>
+    $('div.body').css('margin', 0)
+</script>
+{% endif %}

doc/source/_theme/layout.html

@@ -0,0 +1,4 @@
+{% extends "basic/layout.html" %}
+{% set css_files = css_files + ['_static/tweaks.css'] %}
+
+{% block relbar1 %}{% endblock relbar1 %}

doc/source/_theme/theme.conf

@@ -0,0 +1,4 @@
+[theme]
+inherit = nature
+stylesheet = nature.css
+pygments_style = tango

doc/source/architecture.rst

@@ -0,0 +1,2 @@
+Architecture
+============

doc/source/conf.py

@@ -15,7 +15,15 @@
 import os
 import sys
 
-sys.path.insert(0, os.path.abspath('../..'))
+
+on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+sys.path.insert(0, os.path.abspath('../../'))
+sys.path.insert(0, os.path.abspath('../'))
+sys.path.insert(0, os.path.abspath('./'))
 # -- General configuration ----------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be
@@ -24,12 +32,17 @@ extensions = [
     'sphinx.ext.autodoc',
     'sphinxcontrib.autohttp.flask',
     'sphinxcontrib.pecanwsme.rest',
-    'oslosphinx',
     'wsmeext.sphinxext',
 ]
 
+if not on_rtd:
+    extensions.append('oslosphinx')
+
 wsme_protocols = ['restjson']
 
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
 # autodoc generation is a bit aggressive and a nuisance when doing heavy
 # text edit cycles.
 # execute "export SPHINX_DEBUG=1" in your terminal to disable
@@ -41,9 +54,20 @@ source_suffix = '.rst'
 master_doc = 'index'
 
 # General information about the project.
-project = u'mistral'
+project = u'Mistral'
 copyright = u'2014, Mistral Contributors'
 
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+from mistral.version import version_info
+release = version_info.release_string()
+version = version_info.version_string()
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+show_authors = False
+
 # If true, '()' will be appended to :func: etc. cross-reference text.
 add_function_parentheses = True
 
@@ -56,20 +80,40 @@ pygments_style = 'sphinx'
 
 # -- Options for HTML output --------------------------------------------------
 
-# The theme to use for HTML and HTML Help pages.  Major themes that come with
+# The theme to use for HTML and HTML Help pages.  See the documentation for
-# Sphinx are currently 'default' and 'sphinxdoc'.
+# a list of builtin themes.
-# html_theme_path = ["."]
-# html_theme = '_theme'
 # html_static_path = ['_static']
 
+if on_rtd:
+    html_theme_path = ['.']
+    html_theme = 'sphinx_rtd_theme'
+
 # Output file base name for HTML help builder.
 htmlhelp_basename = '%sdoc' % project
 
+# The name for this set of Sphinx documents. If None, it defaults to
+# "<project> v<release> documentation".
+html_title = 'Mistral'
+
+# Custom sidebar templates, maps document names to template names.
+html_sidebars = {
+    'index': [
+        'sidebarlinks.html', 'localtoc.html', 'searchbox.html', 'sourcelink.html'
+    ],
+    '**': [
+        'localtoc.html', 'relations.html',
+        'searchbox.html', 'sourcelink.html'
+    ]
+}
+
 # -- Options for manual page output -------------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = []
+man_pages = [
+    ('index', 'mistral', u'Mistral',
+     [u'OpenStack Foundation'], 1)
+]
 
 # If true, show URL addresses after external links.
 man_show_urls = True

doc/source/developer/creating_custom_action.rst

@@ -27,11 +27,11 @@ How to write an Action Plugin
 3. Reinstall Mistral if it was installed in system (not in virtualenv).
 4. Run Db-sync tool via either::
 
-  *tools/sync_db.sh --config-file <path-to-config>*
+    *tools/sync_db.sh --config-file <path-to-config>*
 
 or::
 
- *mistral-db-manage --config-file <path-to-config> populate*
+    *mistral-db-manage --config-file <path-to-config> populate*
 
 5. Use your plugin
 

doc/source/developer/devstack.rst

@@ -0,0 +1,4 @@
+Mistral Devstack Installation
+=============================
+
+TBD

doc/source/developer/index.rst

@@ -5,4 +5,6 @@ Developer's Reference
    :maxdepth: 3
 
    webapi/index
-   writing_a_plugin_action
+   creating_custom_action
+   devstack
+   troubleshooting

doc/source/developer/troubleshooting.rst

@@ -0,0 +1,4 @@
+Troubleshooting And Debugging
+=============================
+
+TBD

doc/source/developer/webapi/index.rst

@@ -1,5 +1,5 @@
-REST API
+REST API Specification
-========
+======================
 
 .. toctree::
    :maxdepth: 2

doc/source/guides/configuration_guide.rst

@@ -0,0 +1,4 @@
+Mistral Configuration Guide
+===========================
+
+TBD

doc/source/guides/dashboard_guide.rst

@@ -0,0 +1,4 @@
+Mistral Dashboard Installation Guide
+====================================
+
+TBD

doc/source/guides/installation_guide.rst

@@ -0,0 +1,4 @@
+Mistral Installation Guide
+==========================
+
+TBD

doc/source/guides/mistralclient_guide.rst

@@ -0,0 +1,4 @@
+Mistral Client / CLI Guide
+==========================
+
+TBD: CLI commands and operations

doc/source/guides/upgrade_guide.rst

@@ -0,0 +1,7 @@
+Mistral Upgrade Guide
+=====================
+
+Database Upgrade
+----------------
+
+TBD

doc/source/guides/writing_workflow.rst

@@ -0,0 +1,4 @@
+How To Write Workflow
+=====================
+
+TBD

doc/source/index.rst

@@ -1,23 +1,58 @@
 Welcome to Mistral's documentation!
 ===================================
 
-Contents:
+Mistral is the OpenStack workflow service. This project aims to provide
+a mechanism to define tasks and workflows without writing code, manage
+and execute them in the cloud environment.
+
+Overview
+--------
+
+.. toctree::
+    :maxdepth: 1
+
+    overview
+    quickstart
+    architecture
+    Roadmap <https://wiki.openstack.org/wiki/Mistral/Roadmap>
+    terminology/index
+    main_features
+
+User guide
+----------
+
+**Installation**
 
 .. toctree::
    :maxdepth: 1
 
-   README <readme>
+   guides/installation_guide
-   Overview <overview>
+   guides/configuration_guide
-   quickstart
+   guides/dashboard_guide
+   guides/upgrade_guide
+   guides/mistralclient_guide
+   guides/writing_workflow
+
+**API**
+
+.. toctree::
+   :maxdepth: 2
+
+   developer/webapi/index
+
+**DSL**
 
 .. toctree::
    :maxdepth: 2
 
    dsl/index
 
+Developer guide
+---------------
+
 .. toctree::
-   :maxdepth: 3
+   :maxdepth: 2
-   
+
    developer/index
    
 

doc/source/main_features.rst

@@ -0,0 +1,10 @@
+Mistral Features
+================
+
+TBD:
+ - Task results / Dataflow
+ - Task affinity
+ - Task policies
+ - Loops (with-items)
+ - Service coordinator
+ - Execution expiration policy

doc/source/overview.rst

@@ -1,2 +1,17 @@
 Mistral Overview
-================
+================
+
+What is Mistral?
+----------------
+
+TBD
+
+Main use cases
+--------------
+
+TBD
+
+Rationale
+---------
+
+TBD

doc/source/quickstart.rst

@@ -1,2 +1,4 @@
 Quick Start
-===========
+===========
+
+TBD

doc/source/terminology/actions.rst

@@ -0,0 +1,4 @@
+Actions
+=======
+
+TBD

doc/source/terminology/cron_triggers.rst

@@ -0,0 +1,4 @@
+Cron-triggers
+=============
+
+TBD

doc/source/terminology/executions.rst

@@ -0,0 +1,17 @@
+Executions
+==========
+
+Workflow Execution
+------------------
+
+TBD
+
+Task Execution
+--------------
+
+TBD
+
+Action Execution
+----------------
+
+TBD

doc/source/terminology/index.rst

@@ -0,0 +1,11 @@
+Mistral Terminology
+===================
+
+.. toctree::
+   :maxdepth: 3
+
+   workbooks
+   workflows
+   actions
+   executions
+   cron_triggers

doc/source/terminology/workbooks.rst

@@ -0,0 +1,4 @@
+Workbooks
+=========
+
+TBD

doc/source/terminology/workflows.rst

@@ -0,0 +1,4 @@
+Mistral Workflows
+=================
+
+TBD