[Docs] Add skeleton for My first Murano app guide

Add skeleton for "My first Murano app" guide for third parties
developers. It is needed for voting job creation in project-config that
builds this guide but does not publish it.

The main purpose of this tutorial is to facilitate the learning process
for Murano App newcome developers and show how it's easy to create a
Murano App for their own cloud applications from scratch. This guide
outlines the creation of Plone Murano App step by step:
https://review.openstack.org/#/c/346492/

Change-Id: Ib184891f7c4c94b0bb2ded92648302eaecad6b5b

doc/source/first-app/README.rst

@@ -0,0 +1,43 @@
+==========================================
+My first Murano App getting started  guide
+==========================================
+
+This directory contains the "My first Murano App getting started  guide"
+tutorial.
+
+The tutorials work with an application that can be found in the
+`openstack/murano-apps <http://git.openstack.org/cgit/openstack/murano-apps/tree/Plone/package>`_
+repository.
+
+Prerequisites
+-------------
+
+To build the documentation, you must install the Graphviz package.
+
+/source
+~~~~~~~
+
+The :code:`/source` directory contains the tutorial documentation as
+`reStructuredText <http://docutils.sourceforge.net/rst.html>`_ (RST).
+
+To build the documentation, you must install `Sphinx <http://sphinx-doc.org/>`_ and the
+`OpenStack docs.openstack.org Sphinx theme (openstackdocstheme) <https://pypi.python.org/pypi/openstackdocstheme/>`_. When
+you invoke tox, these dependencies are automatically pulled in from the
+top-level :code:`test-requirements.txt`.
+
+You must also install `Graphviz <http://www.graphviz.org/>`_ on your build system.
+
+The following command invokes :code:`sphinx-build` with :code:`murano-firstapp`::
+
+  tox -e murano-firstapp
+
+/samples
+~~~~~~~~
+
+The code samples in this guide are located in this directory.
+
+/build/murano-firstapp
+~~~~~~~~~~~~~~~~~~~~~~
+
+The HTML documentation is built in this directory. The :code:`.gitignore` file
+for the project specifies this directory.

doc/source/first-app/source/Before_the_start.rst

@@ -0,0 +1,9 @@
+================
+Before the start
+================
+
+What you need
+-------------
+
+Deploy Murano
+-------------

doc/source/first-app/source/Debugging_and_troubleshooting_your_murano_app.rst

@@ -0,0 +1,3 @@
+=============================================
+Debugging and troubleshooting your Murano app
+=============================================

doc/source/first-app/source/Develop_murano_app_for_plone.rst

@@ -0,0 +1,48 @@
+============================
+Develop Murano app for Plone
+============================
+
+Develop standalone Plone Murano app (single VM)
+-----------------------------------------------
+
+Plone server requirements
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Define host VM requirements
+...........................
+
+Host VM operatting system requirements
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Host VM hardware resources requirements
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Define preinstalled software and libraries requirements
+.......................................................
+
+Define what the PloneServerApp should do
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Create and debug sh-script that fully deploys the Plone server on a single VM
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Create Murano package for your app
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Upload and deploy your Murano app to OpenStack cloud
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Develop cluster Plone Murano app (multi VM)
+-------------------------------------------
+
+Develop basic server-client Murano app
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Add load-balancing to the Plone cluster
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Add scalability to the Plone cluster
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Add self-healing to the Plone cluster
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

doc/source/first-app/source/Publish_your_murano_app_in_the_application_catalog.rst

@@ -0,0 +1,15 @@
+==================================================
+Publish your Murano app in the application catalog
+==================================================
+
+Join the OpenStack community
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Prepare testing environment
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Contribute your code to Murano-apps
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Contribute your code to App-catalog
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

doc/source/first-app/source/What_is_the_use_case.rst

@@ -0,0 +1,3 @@
+====================
+What is the use case
+====================

doc/source/first-app/source/What_you_will_learn.rst

@@ -0,0 +1,3 @@
+===================
+What you will learn
+===================

doc/source/first-app/source/Who_is_this_guide_for.rst

@@ -0,0 +1,3 @@
+=====================
+Who is this guide for
+=====================

doc/source/first-app/source/conf.py

@@ -0,0 +1,308 @@
+# 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.
+
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import openstackdocstheme
+import os
+import subprocess
+
+# 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('.'))
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+# needs_sphinx = '1.0'
+
+# 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.todo',
+#    'sphinx.ext.ifconfig',
+#    'sphinxcontrib.nwdiag',
+#    'sphinx.ext.graphviz',
+#    'sphinx.ext.todo'
+#]
+
+# Add any paths that contain templates here, relative to this directory.
+# templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+# source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Murano-FirstApp'
+bug_tag = u'murano-firstapp'
+copyright = u'2016, OpenStack contributors'
+
+# The version info for the project you are documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.1'
+# The full version, including alpha/beta/rc tags.
+release = '0.1'
+
+# A few variables have to be set for the log-a-bug feature.
+#   giturl: The location of conf.py on Git. Must be set manually.
+#   gitsha: The SHA checksum of the bug description. Automatically extracted from git log.
+#   bug_tag: Tag for categorizing the bug. Must be set manually.
+#   bug_project: Project to file bugs against.
+# These variables are passed to the logabug code via html_context.
+giturl = u'http://git.openstack.org/cgit/openstack/murano/tree/doc/source/api-guide/source'
+git_cmd = ["/usr/bin/git", "log", "-1"]
+last_commit = subprocess.Popen(git_cmd, stdout=subprocess.PIPE)
+first_line_cmd = ["head", "-n1"]
+gitsha = subprocess.Popen(first_line_cmd, stdin=last_commit.stdout,
+                stdout=subprocess.PIPE).communicate()[0].split()[-1].strip()
+html_context = {"gitsha": gitsha, "bug_tag": bug_tag,
+                "giturl": giturl,
+                "bug_project": "openstack-api-site"}
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+# language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+# today = ''
+# Else, today_fmt is used as the format for a strftime call.
+# today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = []
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+# default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+# add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+# add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+# show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+# modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+# keep_warnings = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+html_theme = 'openstackdocs'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+# html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+html_theme_path = [openstackdocstheme.get_html_theme_path()]
+
+# The name for this set of Sphinx documents. If None, it defaults to
+# "<project> v<release> documentation".
+# html_title = None
+
+# A shorter title for the navigation bar. Default is the same as html_title.
+# html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+# html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+# html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+# html_static_path = ['_static']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+# html_extra_path = []
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+# So that we can enable "log-a-bug" links from each output HTML page, this
+# variable must be set to a format that includes year, month, day, hours and
+# minutes.
+html_last_updated_fmt = '%Y-%m-%d %H:%M'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+# html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+# html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+# html_additional_pages = {}
+
+# If false, no module index is generated.
+# html_domain_indices = True
+
+# If false, no index is generated.
+html_use_index = False
+
+# If true, the index is split into individual pages for each letter.
+# html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+html_show_sourcelink = False
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+# html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+# html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it. The value of this option must be the
+# base URL from which the finished HTML is served.
+# html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+# html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'MuranoFirstAppdoc'
+
+# If true, publish source files
+html_copy_source = False
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    # 'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+#latex_documents = [
+#    ('index', 'FirstApp.tex', u'FirstApp Documentation',
+#     u'OpenStack Doc Team', 'manual'),
+#]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+# latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+# latex_use_parts = False
+
+# If true, show page references after internal links.
+# latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+# latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+# latex_appendices = []
+
+# If false, no module index is generated.
+# latex_domain_indices = True
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+#man_pages = [
+#    ('index', 'firstapp', u'FirstApp Documentation',
+#     [u'OpenStack Doc Team'], 1)
+#]
+
+# If true, show URL addresses after external links.
+# man_show_urls = False
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+#texinfo_documents = [
+#    ('index', 'FirstApp', u'FirstApp Documentation',
+#     u'OpenStack Doc Team', 'FirstApp', 'One line description of project.',
+#     'Miscellaneous'),
+#]
+
+# Documents to append as an appendix to all manuals.
+# texinfo_appendices = []
+
+# If false, no module index is generated.
+# texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+# texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+# texinfo_no_detailmenu = False
+
+# Set to True to enable printing of the TODO sections
+todo_include_todos = False
+
+# -- Options for Internationalization output ------------------------------
+locale_dirs = ['locale/']
+
+# -- Options for PDF output --------------------------------------------------
+
+#pdf_documents = [
+#    ('index', u'FirstApp', u'FirstApp Documentation',
+#     u'OpenStack contributors')
+#]

doc/source/first-app/source/index.rst

@@ -0,0 +1,17 @@
+=========================================
+My first Murano App getting started guide
+=========================================
+
+Contents
+~~~~~~~~
+
+.. toctree::
+   :maxdepth: 3
+
+   Who_is_this_guide_for
+   What_is_the_use_case
+   What_you_will_learn
+   Before_the_start
+   Develop_murano_app_for_plone
+   Debugging_and_troubleshooting_your_murano_app
+   Publish_your_murano_app_in_the_application_catalog

doc/source/index.rst

@@ -169,4 +169,3 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
-

test-requirements.txt

@@ -26,3 +26,4 @@ oslosphinx>=4.7.0 # Apache-2.0
 sphinx!=1.3b1,<1.4,>=1.2.1 # BSD
 sphinxcontrib-httpdomain # BSD
 reno>=1.8.0 # Apache2
+openstackdocstheme>=1.5.0 # Apache-2.0

tox.ini

@@ -34,6 +34,9 @@ commands = {toxinidir}/tools/cover.sh {posargs}
 [testenv:docs]
 commands = python setup.py build_sphinx
 
+[testenv:murano-firstapp]
+commands = sphinx-build -E -W doc/source/first-app/source doc/build/murano-firstapp/html
+
 [testenv:pyflakes]
 deps = flake8
 commands = flake8