Documentation initial commit

Change-Id: Icb8f6f93726d316241f9d25b56ae98c2c7a3aa72

.gitignore

@@ -45,6 +45,7 @@ nosetests.xml
 coverage.xml
 *,cover
 .hypothesis/
+ChangeLog
 
 # Translations
 *.mo

doc/source/_templates/sidebarlinks.html

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

doc/source/_theme/layout.css

@@ -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

@@ -34,25 +34,15 @@ import warnings
 # 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 = [
-    os.path.abspath('../..'),
-    os.path.abspath('../../bin')
-    ] + sys.path
+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
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.coverage',
-              'sphinx.ext.ifconfig',
-              'sphinx.ext.graphviz',
-              'oslosphinx',
-              'stevedore.sphinxext',
-              'oslo_config.sphinxext',
-              'sphinx.ext.autodoc',
-              'sphinx.ext.viewcode',
-              'oslo_config.sphinxconfiggen',
-              ]
+extensions = []
 
 config_generator_config_file = [
     ('../../etc/oslo-config-generator/glare.conf',
@@ -155,9 +145,9 @@ man_pages = []
 # Add any paths that contain custom themes here, relative to this directory.
 #html_theme_path = ['_theme']
 
-# The name for this set of Sphinx documents.  If None, it defaults to
+# The name for this set of Sphinx documents. If None, it defaults to
 # "<project> v<release> documentation".
-#html_title = None
+html_title = 'Glare'
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
 #html_short_title = None
@@ -235,10 +225,10 @@ htmlhelp_basename = 'glareedoc'
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author,
 # documentclass [howto/manual]).
-latex_documents = [
-    ('index', 'Glare.tex', u'Glare Documentation',
-     u'Glare Team', 'manual'),
-]
+#latex_documents = [
+#    ('index', 'Glare.tex', u'Glare Documentation',
+#     u'Glare Team', 'manual'),
+#]
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.

doc/source/developer/creating_custom_artifact_type.rst

@@ -0,0 +1,2 @@
+How to write an Artifact Type
+=============================

doc/source/developer/devstack.rst

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

doc/source/developer/index.rst

@@ -0,0 +1,10 @@
+Developer's Reference
+=====================
+
+.. toctree::
+   :maxdepth: 3
+
+   webapi/index
+   creating_custom_artifact_type
+   devstack
+   troubleshooting

doc/source/developer/troubleshooting.rst

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

doc/source/developer/webapi/index.rst

@@ -0,0 +1,7 @@
+REST API Specification
+======================
+
+.. toctree::
+   :maxdepth: 2
+
+   v1

doc/source/developer/webapi/v1.rst

@@ -0,0 +1,5 @@
+V1 API
+======
+
+This API describes the ways of interacting with Glare service via HTTP protocol
+using Representational State Transfer concept (ReST).

doc/source/guides/configuration_guide.rst

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

doc/source/guides/dashboard_guide.rst

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

doc/source/guides/glareclient_guide.rst

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

doc/source/guides/hooks_guide.rst

@@ -0,0 +1,4 @@
+Custom Actions Hooks Guide
+==========================
+
+TBD

doc/source/guides/installation_guide.rst

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

doc/source/guides/upgrade_guide.rst

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

doc/source/index.rst

@@ -1,18 +1,58 @@
-..
-      Copyright 2010 OpenStack Foundation
-      All Rights Reserved.
-
-      Licensed under the Apache License, Version 2.0 (the "License"); you may
-      not use this file except in compliance with the License. You may obtain
-      a copy of the License at
-
-          http://www.apache.org/licenses/LICENSE-2.0
-
-      Unless required by applicable law or agreed to in writing, software
-      distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-      WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-      License for the specific language governing permissions and limitations
-      under the License.
-
 Welcome to Glare's documentation!
 =================================
+
+Glare is the OpenStack artifact 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/Glare/Roadmap>
+    main_features
+
+User guide
+----------
+
+**Installation**
+
+.. toctree::
+   :maxdepth: 1
+
+   guides/installation_guide
+   guides/configuration_guide
+   guides/dashboard_guide
+   guides/upgrade_guide
+   guides/glareclient_guide
+   guides/hooks_guide
+
+**API**
+
+.. toctree::
+   :maxdepth: 2
+
+   developer/webapi/index
+
+
+Developer guide
+---------------
+
+.. toctree::
+   :maxdepth: 2
+
+   developer/index
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+

doc/source/main_features.rst

@@ -0,0 +1,4 @@
+Glare Features
+==============
+
+TBD

doc/source/overview.rst

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

doc/source/quickstart.rst

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

tox.ini

@@ -1,6 +1,6 @@
 [tox]
 minversion = 1.6
-envlist = py34,py27,pep8
+envlist = py27,pep8,py34
 skipsdist = True
 
 [testenv]