Merge "Murano docs structure"

doc/source/draft/admin-guide/admin_troubleshooting.rst

@@ -0,0 +1,11 @@
+.. _admin-troubleshooting:
+
+.. toctree::
+   :maxdepth: 2
+
+===============
+Troubleshooting
+===============
+
+.. TODO This section will contain subsections titled according
+   to issues they are dedicated to.

doc/source/draft/admin-guide/installation.rst

@@ -0,0 +1,14 @@
+.. _installation:
+
+.. toctree::
+   :maxdepth: 2
+
+============
+Installation
+============
+
+Network configuration
+~~~~~~~~~~~~~~~~~~~~~
+
+Policy configuration
+~~~~~~~~~~~~~~~~~~~~

doc/source/draft/admin-guide/manage_categories.rst

@@ -0,0 +1,8 @@
+.. _manage-categories:
+
+.. toctree::
+   :maxdepth: 2:
+
+===================
+Managing categories
+===================

doc/source/draft/admin-guide/manage_images.rst

@@ -0,0 +1,14 @@
+.. _manage-images:
+
+.. toctree::
+   :maxdepth: 2:
+
+===============
+Managing images
+===============
+
+Build an image
+~~~~~~~~~~~~~~
+
+Manage images
+~~~~~~~~~~~~~

doc/source/draft/admin-guide/murano_repository.rst

@@ -0,0 +1,14 @@
+.. _murano-repository:
+
+.. toctree::
+   :maxdepth: 2:
+
+=================
+Murano repository
+=================
+
+Use an existing repository
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Set up a custom repository
+~~~~~~~~~~~~~~~~~~~~~~~~~~

doc/source/draft/admin-guide/use_cli.rst

@@ -0,0 +1,23 @@
+.. _use-cli:
+
+.. toctree::
+   :maxdepth: 2:
+
+=========
+Using CLI
+=========
+
+Install murano client
+~~~~~~~~~~~~~~~~~~~~~
+
+Manage applications
+~~~~~~~~~~~~~~~~~~~
+
+Manage environments
+~~~~~~~~~~~~~~~~~~~
+
+Manage categories
+~~~~~~~~~~~~~~~~~
+
+Use Murano repository
+~~~~~~~~~~~~~~~~~~~~~

doc/source/draft/appdev-guide/exec_plan.rst

@@ -0,0 +1,8 @@
+.. _exec_plan:
+
+.. toctree::
+   :maxdepth: 2
+
+=======================
+Execution Plan template
+=======================

doc/source/draft/appdev-guide/faq.rst

@@ -0,0 +1,8 @@
+.. _faq:
+
+.. toctree::
+   :maxdepth: 2
+
+====
+FAQs
+====

doc/source/draft/appdev-guide/hot_packages.rst

@@ -0,0 +1,14 @@
+.. _hot-packages:
+
+.. toctree::
+   :maxdepth: 2
+
+============
+HOT packages
+============
+
+Compose a package
+~~~~~~~~~~~~~~~~~
+
+Upload a package
+~~~~~~~~~~~~~~~~

doc/source/draft/appdev-guide/murano_packages.rst

@@ -0,0 +1,17 @@
+.. _murano-packages:
+
+.. toctree::
+   :maxdepth: 2
+
+===============
+Murano packages
+===============
+
+Package structure
+~~~~~~~~~~~~~~~~~
+
+Dynamic UI definition specification
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Murano package repository
+~~~~~~~~~~~~~~~~~~~~~~~~~

doc/source/draft/appdev-guide/murano_pl.rst

@@ -0,0 +1,20 @@
+.. _murano-pl:
+
+.. toctree::
+   :maxdepth: 2
+
+==================
+MuranoPL Reference
+==================
+
+YAML
+~~~~
+
+YAQL
+~~~~
+
+Common class structure
+~~~~~~~~~~~~~~~~~~~~~~
+
+Core library
+~~~~~~~~~~~~

doc/source/draft/appdev-guide/packages.rst

@@ -0,0 +1,14 @@
+.. _packages:
+
+.. toctree::
+   :maxdepth: 2
+
+========
+Packages
+========
+
+HOT-based packages
+~~~~~~~~~~~~~~~~~~
+
+Murano native packages
+~~~~~~~~~~~~~~~~~~~~~~

doc/source/draft/appdev-guide/step_by_step.rst

@@ -0,0 +1,8 @@
+.. _step-by-step:
+
+.. toctree::
+   :maxdepth: 2
+
+============
+Step-by-Step
+============

doc/source/draft/appdev-guide/use_cases.rst

@@ -0,0 +1,8 @@
+.. _use-cases:
+
+.. toctree::
+   :maxdepth: 2
+
+=========
+Use-cases
+=========

doc/source/draft/appendix/cli_ref.rst

@@ -0,0 +1,10 @@
+.. _cli-ref:
+
+.. toctree::
+   :maxdepth: 2:
+
+=============
+CLI reference
+=============
+
+.. TODO this section should be autogenerated

doc/source/draft/appendix/glossary.rst

@@ -0,0 +1,8 @@
+.. _glossary:
+
+.. toctree::
+   :maxdepth: 2
+
+========
+Glossary
+========

doc/source/draft/appendix/murano_concepts.rst

@@ -0,0 +1,8 @@
+.. _murano-concepts:
+
+.. toctree::
+   :maxdepth: 2:
+
+=========================================
+High-level definitions of Murano concepts
+=========================================

doc/source/draft/appendix/rest_api_spec.rst

@@ -0,0 +1,8 @@
+.. _rest-api-spec:
+
+.. toctree::
+   :maxdepth: 2:
+
+======================
+REST API specification
+======================

doc/source/draft/appendix/tutorials.rst

@@ -0,0 +1,20 @@
+.. _tutorials:
+
+.. meta::
+   :robots: noindex
+
+.. toctree::
+   :maxdepth: 2
+
+=========
+Tutorials
+=========
+
+Integration with Docker
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Integration with Kubernetes
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+HA and autoscaling
+~~~~~~~~~~~~~~~~~~

doc/source/draft/contributor-guide/dev_env.rst

@@ -0,0 +1,8 @@
+.. _dev-env:
+
+.. toctree::
+   :maxdepth: 2
+
+=======================
+Development environment
+=======================

doc/source/draft/contributor-guide/dev_guidelines.rst

@@ -0,0 +1,20 @@
+.. _dev-guidelines:
+
+.. toctree::
+   :maxdepth: 2
+
+======================
+Development guidelines
+======================
+
+Conventions
+~~~~~~~~~~~
+
+High-level overview of Murano components
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Coding guidelines
+~~~~~~~~~~~~~~~~~
+
+Debug tips
+~~~~~~~~~~

doc/source/draft/contributor-guide/doc_guidelines.rst

@@ -0,0 +1,8 @@
+.. _doc-guidelines:
+
+.. toctree::
+   :maxdepth: 2
+
+========================
+Documentation guidelines
+========================

doc/source/draft/contributor-guide/how_to_contribute.rst

@@ -0,0 +1,13 @@
+.. _how_to_contribute:
+
+=================
+How to contribute
+=================
+
+.. TODO add a brief intro:
+   - Intended audience.
+   - How to start developing?
+   - How a new-comer can contribute?
+   - Communication channels
+   - Useful links for an OpenStack contributor
+   - consider the context of http://docs.openstack.org/developer/sahara/devref/how_to_participate.html

doc/source/draft/contributor-guide/plugin_development.rst

@@ -0,0 +1,8 @@
+.. _plugin-development:
+
+.. toctree::
+   :maxdepth: 2
+
+===================
+Developing a plugin
+===================

doc/source/draft/contributor-guide/testing.rst

@@ -0,0 +1,28 @@
+.. _testing:
+
+.. toctree::
+   :maxdepth: 2
+
+=======
+Testing
+=======
+
+Testing guidelines
+~~~~~~~~~~~~~~~~~~
+
+Continuous Integration service
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+UI testing
+~~~~~~~~~~
+
+Tempest tests
+~~~~~~~~~~~~~
+
+Automated testing machinery
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+CI design
+---------
+CI jobs
+-------

doc/source/draft/enduser-guide/manage_applications.rst

@@ -0,0 +1,38 @@
+.. manage_applications:
+
+.. toctree::
+   :maxdepth: 2
+
+=====================
+Managing applications
+=====================
+
+Import an application package
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+From a zip file
+---------------
+
+From a repository
+-----------------
+
+From a bundle of applications
+-----------------------------
+
+From a local bundle of applications
+-----------------------------------
+
+Search for an application in the catalog
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Add and delete an application
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Deploy an application
+~~~~~~~~~~~~~~~~~~~~~
+
+Show an application topology
+----------------------------
+
+Show a deployment log location
+------------------------------

doc/source/draft/enduser-guide/manage_environments.rst

@@ -0,0 +1,20 @@
+.. _manage-environments:
+
+.. toctree::
+   :maxdepth: 2
+
+=====================
+Managing environments
+=====================
+
+Create an environment
+~~~~~~~~~~~~~~~~~~~~~
+
+Edit an environment
+~~~~~~~~~~~~~~~~~~~
+
+Review an environment
+~~~~~~~~~~~~~~~~~~~~~
+
+Analyze logs
+~~~~~~~~~~~~

doc/source/draft/enduser-guide/quickstart.rst

@@ -0,0 +1,5 @@
+.. quickstart:
+
+==========
+Quickstart
+==========

doc/source/draft/enduser-guide/troubleshooting.rst

@@ -0,0 +1,11 @@
+.. _enduser-troubleshooting:
+
+.. toctree::
+   :maxdepth: 2
+
+===============
+Troubleshooting
+===============
+
+.. TODO This section will contain subsections titled according
+   to issues they are dedicated to.

doc/source/draft/index.rst

@@ -0,0 +1,90 @@
+.. meta::
+   :robots: noindex, nofollow
+
+.. _content:
+
+===============================
+Welcome to Murano Documentation
+===============================
+
+.. TODO add Abstract (OG)
+
+
+Introduction
+~~~~~~~~~~~~
+
+.. toctree::
+   :maxdepth: 2
+
+   intro/whats_murano
+   intro/key_features
+   intro/architecture
+   intro/use_cases
+   intro/user_stories
+
+End User Guide
+~~~~~~~~~~~~~~
+
+.. toctree::
+   :maxdepth: 2
+
+   enduser-guide/quickstart
+   enduser-guide/manage_environments
+   enduser-guide/manage_applications
+   enduser-guide/troubleshooting
+
+Admin User Guide
+~~~~~~~~~~~~~~~~
+
+.. toctree::
+   :maxdepth: 2
+
+   admin-guide/installation
+   admin-guide/manage_images
+   admin-guide/manage_categories
+   admin-guide/murano_repository
+   admin-guide/use_cli
+   admin-guide/admin_troubleshooting
+
+
+Developing Applications
+~~~~~~~~~~~~~~~~~~~~~~~
+
+.. toctree::
+   :maxdepth: 2
+
+   appdev-guide/step_by_step
+   appdev-guide/exec_plan
+   appdev-guide/hot_packages
+   appdev-guide/murano_pl
+   appdev-guide/murano_packages
+   appdev-guide/examples
+   appdev-guide/use_cases
+   appdev-guide/faq
+
+
+Contributing
+~~~~~~~~~~~~
+
+.. toctree::
+   :maxdepth: 2
+
+   contributor-guide/how_to_contribute
+   contributor-guide/dev_guidelines
+   contributor-guide/plugin_development
+   contributor-guide/deploy_local_dev_env
+   contributor-guide/testing
+   contributor-guide/doc_guidelines
+
+
+Appendix
+~~~~~~~~
+
+.. toctree::
+   :maxdepth: 2
+
+   appendix/glossary
+   appendix/murano_concepts
+   appendix/tutorials
+   appendix/rest_api_spec
+   appendix/cli_ref

doc/source/draft/intro/architecture.rst

@@ -0,0 +1,5 @@
+.. _architecture:
+
+============
+Architecture
+============

doc/source/draft/intro/key_features.rst

@@ -0,0 +1,8 @@
+.. _key-features:
+
+.. toctree::
+   :maxdepth: 2
+
+============
+Key features
+============

doc/source/draft/intro/use_cases.rst

@@ -0,0 +1,8 @@
+.. _use-cases:
+
+.. toctree::
+   :maxdepth: 2
+
+=========
+Use cases
+=========

doc/source/draft/intro/user_stories.rst

@@ -0,0 +1,8 @@
+.. _user-stories:
+
+.. toctree::
+   :maxdepth: 2
+
+============
+User stories
+============

doc/source/draft/intro/whats_murano.rst

@@ -0,0 +1,5 @@
+.. _whats-murano:
+
+===============
+What is Murano?
+===============

doc/source/index.rst

@@ -111,9 +111,18 @@ contribute to the project.
 
    specification/index
 
+
 Indices and tables
 ==================
 
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
+
+BETA: Murano documentation
+==========================
+
+.. toctree::
+   :maxdepth: 1
+
+   draft/index