/docs_build/
/docs/projects/
/docs_output/
-/releng/
+/releng/
\ No newline at end of file
--- /dev/null
+[submodule "docs/submodules/apex"]
+ path = docs/submodules/apex
+ url = https://gerrit.opnfv.org/gerrit/apex
+ branch = .
+[submodule "docs/submodules/armband"]
+ path = docs/submodules/armband
+ url = https://gerrit.opnfv.org/gerrit/armband
+ branch = .
+[submodule "docs/submodules/bottlenecks"]
+ path = docs/submodules/bottlenecks
+ url = https://gerrit.opnfv.org/gerrit/bottlenecks
+ branch = .
+[submodule "docs/submodules/compass4nfv"]
+ path = docs/submodules/compass4nfv
+ url = https://gerrit.opnfv.org/gerrit/compass4nfv
+ branch = .
+[submodule "docs/submodules/conductor"]
+ path = docs/submodules/conductor
+ url = https://gerrit.opnfv.org/gerrit/conductor
+ branch = .
+[submodule "docs/submodules/copper"]
+ path = docs/submodules/copper
+ url = https://gerrit.opnfv.org/gerrit/copper
+ branch = .
+[submodule "docs/submodules/daisy"]
+ path = docs/submodules/daisy
+ url = https://gerrit.opnfv.org/gerrit/daisy
+ branch = .
+[submodule "docs/submodules/domino"]
+ path = docs/submodules/domino
+ url = https://gerrit.opnfv.org/gerrit/domino
+ branch = .
+[submodule "docs/submodules/dpacc"]
+ path = docs/submodules/dpacc
+ url = https://gerrit.opnfv.org/gerrit/dpacc
+ branch = .
+[submodule "docs/submodules/enfv"]
+ path = docs/submodules/enfv
+ url = https://gerrit.opnfv.org/gerrit/enfv
+ branch = .
+[submodule "docs/submodules/escalator"]
+ path = docs/submodules/escalator
+ url = https://gerrit.opnfv.org/gerrit/escalator
+ branch = .
+[submodule "docs/submodules/fastpathmetrics"]
+ path = docs/submodules/fastpathmetrics
+ url = https://gerrit.opnfv.org/gerrit/fastpathmetrics
+ branch = .
+[submodule "docs/submodules/fds"]
+ path = docs/submodules/fds
+ url = https://gerrit.opnfv.org/gerrit/fds
+ branch = .
+[submodule "docs/submodules/fuel"]
+ path = docs/submodules/fuel
+ url = https://gerrit.opnfv.org/gerrit/fuel
+ branch = .
+[submodule "docs/submodules/functest"]
+ path = docs/submodules/functest
+ url = https://gerrit.opnfv.org/gerrit/functest
+ branch = .
+[submodule "docs/submodules/genesisreq"]
+ path = docs/submodules/genesisreq
+ url = https://gerrit.opnfv.org/gerrit/genesisreq
+ branch = .
+[submodule "docs/submodules/inspector"]
+ path = docs/submodules/inspector
+ url = https://gerrit.opnfv.org/gerrit/inspector
+ branch = .
+[submodule "docs/submodules/ipv6"]
+ path = docs/submodules/ipv6
+ url = https://gerrit.opnfv.org/gerrit/ipv6
+ branch = .
+[submodule "docs/submodules/joid"]
+ path = docs/submodules/joid
+ url = https://gerrit.opnfv.org/gerrit/joid
+ branch = .
+[submodule "docs/submodules/kvmfornfv"]
+ path = docs/submodules/kvmfornfv
+ url = https://gerrit.opnfv.org/gerrit/kvmfornfv
+ branch = .
+[submodule "docs/submodules/lsoapi"]
+ path = docs/submodules/lsoapi
+ url = https://gerrit.opnfv.org/gerrit/lsoapi
+ branch = .
+[submodule "docs/submodules/moon"]
+ path = docs/submodules/moon
+ url = https://gerrit.opnfv.org/gerrit/moon
+ branch = .
+[submodule "docs/submodules/multisite"]
+ path = docs/submodules/multisite
+ url = https://gerrit.opnfv.org/gerrit/multisite
+ branch = .
+[submodule "docs/submodules/netready"]
+ path = docs/submodules/netready
+ url = https://gerrit.opnfv.org/gerrit/netready
+ branch = .
+[submodule "docs/submodules/octopus"]
+ path = docs/submodules/octopus
+ url = https://gerrit.opnfv.org/gerrit/octopus
+ branch = .
+[submodule "docs/submodules/onosfw"]
+ path = docs/submodules/onosfw
+ url = https://gerrit.opnfv.org/gerrit/onosfw
+ branch = .
+[submodule "docs/submodules/ovsnfv"]
+ path = docs/submodules/ovsnfv
+ url = https://gerrit.opnfv.org/gerrit/ovsnfv
+ branch = .
+[submodule "docs/submodules/parser"]
+ path = docs/submodules/parser
+ url = https://gerrit.opnfv.org/gerrit/parser
+ branch = .
+[submodule "docs/submodules/pharos"]
+ path = docs/submodules/pharos
+ url = https://gerrit.opnfv.org/gerrit/pharos
+ branch = .
+[submodule "docs/submodules/prediction"]
+ path = docs/submodules/prediction
+ url = https://gerrit.opnfv.org/gerrit/prediction
+ branch = .
+[submodule "docs/submodules/promise"]
+ path = docs/submodules/promise
+ url = https://gerrit.opnfv.org/gerrit/promise
+ branch = .
+[submodule "docs/submodules/qtip"]
+ path = docs/submodules/qtip
+ url = https://gerrit.opnfv.org/gerrit/qtip
+ branch = .
+[submodule "docs/submodules/releng"]
+ path = docs/submodules/releng
+ url = https://gerrit.opnfv.org/gerrit/releng
+ branch = .
+[submodule "docs/submodules/sdnvpn"]
+ path = docs/submodules/sdnvpn
+ url = https://gerrit.opnfv.org/gerrit/sdnvpn
+ branch = .
+[submodule "docs/submodules/sfc"]
+ path = docs/submodules/sfc
+ url = https://gerrit.opnfv.org/gerrit/sfc
+ branch = .
+[submodule "docs/submodules/storperf"]
+ path = docs/submodules/storperf
+ url = https://gerrit.opnfv.org/gerrit/storperf
+ branch = .
+[submodule "docs/submodules/ves"]
+ path = docs/submodules/ves
+ url = https://gerrit.opnfv.org/gerrit/ves
+ branch = .
+[submodule "docs/submodules/vnf_forwarding_graph"]
+ path = docs/submodules/vnf_forwarding_graph
+ url = https://gerrit.opnfv.org/gerrit/vnf_forwarding_graph
+ branch = .
+[submodule "docs/submodules/vswitchperf"]
+ path = docs/submodules/vswitchperf
+ url = https://gerrit.opnfv.org/gerrit/vswitchperf
+ branch = .
+[submodule "docs/submodules/yardstick"]
+ path = docs/submodules/yardstick
+ url = https://gerrit.opnfv.org/gerrit/yardstick
+ branch = .
+[submodule "docs/submodules/doctor"]
+ path = docs/submodules/doctor
+ url = https://gerrit.opnfv.org/gerrit/doctor
+ branch = .
+[submodule "docs/submodules/availability"]
+ path = docs/submodules/availability
+ url = https://gerrit.opnfv.org/gerrit/availability
+ branch = .
+[submodule "docs/submodules/dovetail"]
+ path = docs/submodules/dovetail
+ url = https://gerrit.opnfv.org/gerrit/dovetail
+ branch = .
--- /dev/null
+import sphinx_bootstrap_theme
+
+# 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.
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+needs_sphinx = '1.3'
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions=['sphinxcontrib.httpdomain', 'sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'sphinx.ext.napoleon']
+# Disable javasphinx generation until we have a solution to long build
+# times. readthedocs timesout after 902 seconds.
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+# source_suffix = ['.rst', '.md']
+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 = 'Documentation'
+copyright = '2017, OPNFV. Licensed under CC BY 4.0'
+author = 'Open Platform for NFV'
+
+# 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.
+#
+# The short X.Y version.
+version = 'Colorado'
+# The full version, including alpha/beta/rc tags.
+release = 'Colorado'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+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.
+# This patterns also effect to html_static_path and html_extra_path
+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
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = 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 = 'bootstrap'
+
+# 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 = {}
+html_theme_options = {
+ 'bootswatch_theme': "united",
+}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
+
+# The name for this set of Sphinx documents.
+# "<project> v<release> documentation" by default.
+#html_title = 'OpenDaylight Documentation v0.3.0'
+
+# 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 = '_static/opnfv-logo.png'
+
+# The name of an image file (relative to this directory) to use as a favicon of
+# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+html_favicon = '_static/favicon.ico'
+
+# 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 None, a 'Last updated on:' timestamp is inserted at every page
+# bottom, using the given strftime format.
+# The empty string is equivalent to '%b %d, %Y'.
+#html_last_updated_fmt = None
+
+# 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 = True
+
+# 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 = True
+
+# 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
+
+# Language to be used for generating the HTML full-text search index.
+# Sphinx supports the following languages:
+# 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
+# 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh'
+#html_search_language = 'en'
+
+# A dictionary with options for the search language support, empty by default.
+# 'ja' uses this config value.
+# 'zh' user can custom change `jieba` dictionary path.
+#html_search_options = {'type': 'default'}
+
+# The name of a javascript file (relative to the configuration directory) that
+# implements a search results scorer. If empty, the default will be used.
+#html_search_scorer = 'scorer.js'
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'OPNFV'
+
+# -- 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': '',
+
+# Latex figure (float) alignment
+#'figure_align': 'htbp',
+}
+
+# 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 = [
+ (master_doc, 'OPNFV.tex', 'OPNFV Documentation',
+ 'OPNFV Project', '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 = [
+ (master_doc, 'OPNFVDocs', 'OPNFV Documentation',
+ [author], 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 = [
+ (master_doc, 'OPNFVDocs', 'OPNFV Documentation',
+ author, 'OPNFV', '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
+
+# intersphinx_mapping = {'RTD':('http://opnfvdocsdemo.readthedocs.io/projects/', None)}
\ No newline at end of file
--- /dev/null
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) <optionally add copywriters name>
+
+=====================
+<feature> Design
+=====================
+
+.. describe which upstream components (e.g. OpenStack modules, ..) are working together to provide the functionality
+.. describe some deployment architecture
+.. fill the gap between the release notes and the detailed documentation provided by the participating projects or upstream communities
+
+.. toctree::
+ :maxdepth: 2
+
+ ./design.rst
+
--- /dev/null
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) <optionally add copywriters name>
+
+======================
+<feature> Integration
+======================
+
+Introduction
+==============
+..Brief on what scenario's the project can be integrated to.
+
+Integration Steps for <>
+===========================
+.. List steps to integrate <project> with <scenario>
--- /dev/null
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) <optionally add copywriters name>
+
+===================================
+<scenario> Overview and Description
+===================================
+.. This document will be used to provide a description of the scenario for an end user.
+.. You should explain the purpose of the scenario, the types of capabilities provided and
+.. the unique components that make up the scenario including how they are used.
+
+.. toctree::
+ :maxdepth: 3
+
+ ./scenario.description.rst
--- /dev/null
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) <optionally add copywriters name>
+
+Introduction
+============
+.. In this section explain the purpose of the scenario and the types of capabilities provided
+
+Scenario components and composition
+===================================
+.. In this section describe the unique components that make up the scenario,
+.. what each component provides and why it has been included in order
+.. to communicate to the user the capabilities available in this scenario.
+
+Scenario usage overview
+=======================
+.. Provide a brief overview on how to use the scenario and the features available to the
+.. user. This should be an "introduction" to the userguide document, and explicitly link to it,
+.. where the specifics of the features are covered including examples and API's
+
+Limitations, Issues and Workarounds
+===================================
+.. Explain scenario limitations here, this should be at a design level rather than discussing
+.. faults or bugs. If the system design only provide some expected functionality then provide
+.. some insight at this point.
+
+References
+==========
+
+For more information on the OPNFV Danube release, please visit
+http://www.opnfv.org/danube
--- /dev/null
+OPNFV Feature Projects
+=======================
+
+ARMband
+--------
+.. toctree::
+ :maxdepth: 1
+
+ ../submodules/armband/docs/releasenotes/index
+ ../submodules/armband/docs/installationprocedure/index
+
+Copper
+--------
+.. toctree::
+ :maxdepth: 1
+
+ ../submodules/copper/docs/design/index
+ ../submodules/copper/docs/releasenotes/index
+ ../submodules/copper/docs/userguide/index
+ ../submodules/copper/docs/installationprocedure/index
+
+Doctor
+--------
+.. toctree::
+ :maxdepth: 1
+
+ ../submodules/doctor/docs/scenario/index
+ ../submodules/doctor/docs/installationprocedure/index
+ ../submodules/doctor/docs/userguide/index
+ ../submodules/doctor/docs/releasenotes/index
+
+Domino
+--------
+.. toctree::
+ :maxdepth: 1
+
+ ../submodules/domino/docs/installationprocedure/index
+ ../submodules/domino/docs/userguide/index
+
+IPV6
+--------
+.. toctree::
+ :maxdepth: 1
+
+ ../submodules/ipv6/docs/userguide/index
+ ../submodules/ipv6/docs/configurationguide/index
+
+KVM for NFV
+-------------
+.. toctree::
+ :maxdepth: 1
+
+ ../submodules/kvmfornfv/docs/userguide/index
+ ../submodules/kvmfornfv/docs/configurationguide/index
+ ../submodules/kvmfornfv/docs/installationprocedure/index
+ ../submodules/kvmfornfv/docs/releasenotes/index
+
+Moon
+------
+.. toctree::
+ :maxdepth: 1
+
+ ../submodules/moon/docs/userguide/index
+ ../submodules/moon/docs/installationprocedure/index
+ ../submodules/moon/docs/releasenotes/index
+
+Multisite
+------------
+.. toctree::
+ :maxdepth: 1
+
+ ../submodules/multisite/docs/userguide/index
+ ../submodules/multisite/docs/installationprocedure/index
+ ../submodules/multisite/docs/releasenotes/index
+
+
+Netready
+------------
+.. toctree::
+ :maxdepth: 1
+
+ ../submodules/netready/docs/requirements/index
+
+
+ONOS
+-------
+.. toctree::
+ :maxdepth: 1
+
+ ../submodules/onosfw/docs/userguide/index
+ ../submodules/onosfw/docs/installationprocedure/index
+
+OVSNFV
+--------
+.. toctree::
+ :maxdepth: 1
+
+ ../submodules/ovsnfv/docs/userguide/index
+ ../submodules/ovsnfv/docs/configguide/index
+
+
+Parser
+--------
+.. toctree::
+ :maxdepth: 1
+
+ ../submodules/parser/docs/userguide/index
+ ../submodules/parser/docs/installationprocedure/index
+
+
+Pharos
+--------
+.. toctree::
+ :maxdepth: 1
+
+ ../submodules/pharos/docs/specification/index
+ ../submodules/pharos/docs/configguide/index
+
+Promise
+--------
+.. toctree::
+ :maxdepth: 1
+
+ ../submodules/promise/docs/requirements/index
+ ../submodules/promise/docs/installationprocedure/index
+ ../submodules/promise/docs/userguide/index
+
+
+SDNVPN
+--------
+.. toctree::
+ :maxdepth: 1
+
+ ../submodules/sdnvpn/docs/scenarios/os-odl_l2-bgpvpn/index
+ ../submodules/sdnvpn/docs/userguide/index
+ ../submodules/sdnvpn/docs/release-notes/index
+
+
+SFC
+-----
+.. toctree::
+ :maxdepth: 1
+
+ ../submodules/sfc/docs/userguide/index
+ ../submodules/sfc/docs/releasenotes/index
+ ../submodules/sfc/docs/installationprocedure/index
+
+
+Software fast-path quality metrics
+------------------------------------
+.. toctree::
+ :maxdepth: 1
+
+ ../submodules/fastpathmetrics/docs/userguide/index
+ ../submodules/fastpathmetrics/docs/requirements/index
+ ../submodules/fastpathmetrics/docs/configguide/index
\ No newline at end of file
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. (c) Ericsson AB
+OPNFV Documentation
+===================
-***********************************
-OPNFV Docs placeholder landing page
-***********************************
+Open Platform for NFV (OPNFV) facilitates the development and evolution
+of NFV components across various open source ecosystems. Through
+system level integration, deployment and testing, OPNFV creates a
+reference NFV platform to accelerate the transformation of enterprise
+and service provider networks. Participation is open to anyone,
+whether you are an employee of a member company or just passionate
+about network transformation.
-This will be extended to include all the sub pages and to provide the docs.opnfv.org landing page for Danube.
-
-=====================
Release Documentation
-=====================
-
-Just pointing to the index.rst file here, but we need to break that out and have
-sub-directories for each of the projects documents to be copied into.
+----------------------
.. toctree::
:maxdepth: 1
- release/index
-
-.. need to figure out the correct URL to use here so readthedocs does it for us.
+ release/overview
+ release/installation.introduction
+ release/userguide.introduction
+ release/subrelease
-=======
-Testing
-=======
-Just pointing to the index.rst file here, but we need to break that out and have
-sub-directories for each of the projects documents to be copied into.
+Developer Documentation
+-----------------------------------
.. toctree::
:maxdepth: 1
- testing/index
+ featureprojects
-=========
-Developer
-=========
-Just pointing to the index.rst file here, but we need to break that out and have
-sub-directories for each of the projects documents to be copied into.
+Testing Documentation
+-------------------------------------
.. toctree::
:maxdepth: 1
- developer/index
+ submodules/functest/docs/userguide/index
+ submodules/bottlenecks/docs/userguide/index
+ submodules/yardstick/docs/userguide/index
+ submodules/vswitchperf/docs/index
+
+.. Commenting the below out until we actually use it
+.. Indices and tables
+.. ==================
+..
+.. * :ref:`genindex`
+.. * :ref:`modindex`
+.. * :ref:`search`
\ No newline at end of file
--- /dev/null
+=============================================
+<Project Name> <Release Name> Installation
+=============================================
+
+
+Preparing for Installation
+=====================================
+Include any pre configuration, database, or other software downloads
+required to install <project>.
+
+Installing <Feature>
+====================================
+Installation toolkit
+
+Verifying your Installation
+====================================
+Describe how to verify the installation.
+
+Troubleshooting
+====================================
+<optional>
+Text goes here.
\ No newline at end of file
--- /dev/null
+=================================================
+<Project Name> <Release Name> Post Installation
+=================================================
+
+
+Post Installation Configuration
+=====================================
+Post Installation Configuration section must include some basic
+(must-do) procedures if any, to get started.
+
+Upgrading From <a Previous Release>
+====================================
+Text goes here.
+
+?Uninstalling? <Feature>
+====================================
+Text here.
--- /dev/null
+===================================
+<Scenario> Installation Guide
+===================================
+
+.. toctree::
+ :maxdepth: 2
+
+ prerequisite
+ <scenario>-installation
+ <scenario>-postinstallation
\ No newline at end of file
--- /dev/null
+=============================================
+<Project Name> <Release Name> Abstract
+=============================================
+.. Example, Joid Danube Abstract
+
+Abstract explaining the Document
\ No newline at end of file
--- /dev/null
+==============================================
+<Project Name> <Release Name> Compatibility
+==============================================
+
+
+Compatibility with Previous Releases
+=======================================
+<optional, required if there's a previous release>
+Is it compatible? Did anything about how a user or developer would
+consume it change? If so, document it here.
+
+Migration from Previous Releases
+=====================================
+<optional, required if there's a previous release for the project>
+
+Describe any special step somebody would have to take to migrate from a
+previous release to this one. If migration isn't supported for some
+combinations, state that as well.
\ No newline at end of file
--- /dev/null
+===================================
+<Project Name> Installation Guide
+===================================
+
+Installation Guide
+===================
+Refer to https://wiki.opnfv.org/display/DOC/Installation+procedure
+Naming Convention is: <Name> <Use Case> <file name>. Eg: Apex Installation Guide Abstract
+
+.. toctree::
+ :maxdepth: 2
+
+ abstract
+ prerequisite
+ supportedscenario
+ <scenario>/index
+ compatibility
+ references
\ No newline at end of file
--- /dev/null
+=============================================
+<Project Name> <Release Name> Prerequisite
+=============================================
+
+
+Hardware requirement
+=====================================
+List out the HW requirements
+
+Software requirement
+====================================
+List out the SW requirements
+
+Configurations
+====================================
\ No newline at end of file
--- /dev/null
+===================================================
+<Project Name> <Release Name> Supported Scenarios
+===================================================
+
+<Brief>
+=========
+Add a short brief about supported scenarios
+
+.. toctree::
+ :maxdepth: 2
+
+ development/<scenario1>/index
+ development/<scenario2>/index
\ No newline at end of file
--- /dev/null
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Ericsson AB and others.
+
+=============================================
+<Project Name> <Release Name> Overview
+=============================================
+
+For example, the title might be "Qtip Danube Overview"
+
+<Brief (Optional)>
+===================
+
+.. toctree::
+ :maxdepth: 2
+
+ overview
--- /dev/null
+==============================================
+<Project Name> <Release Name> Overview
+==============================================
+
+
+Introduction
+=======================================
+Describing the components and behaviours in a manner that helps people understand the platform and how to work with it
+
+Upgrades from <Previous Release>
+=====================================
+<optional, required if there's a previous release for the project>
+Describe the new features
\ No newline at end of file
--- /dev/null
+=============================================
+<Project Name> <Release Name> Bugs
+=============================================
+
+
+Resolved Bugs
+===============
+List open and resolved bugs if any.
+
+**JIRA TICKETS:**
+
++--------------------------------------+--------------------------------------+
+| **JIRA REFERENCE** | **SLOGAN** |
+| | |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-86 | Need ability to specify number of |
+| | compute nodes |
++--------------------------------------+--------------------------------------+
+
+Deprecated and Removed Capabilities
+=====================================
+Provide information about the capabilities that are removed or
+deprecated in this release.
+
+**JIRA TICKETS:**
+
++--------------------------------------+--------------------------------------+
+| **JIRA REFERENCE** | **SLOGAN** |
+| | |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-86 | Need ability to specify number of |
+| | compute nodes |
++--------------------------------------+--------------------------------------+
+
+Known Limitations
+=====================================
+Provide information about the capabilities that are removed or
+deprecated in this release.
+
+**JIRA TICKETS:**
+
++--------------------------------------+--------------------------------------+
+| **JIRA REFERENCE** | **SLOGAN** |
+| | |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-86 | Need ability to specify number of |
+| | compute nodes |
++--------------------------------------+--------------------------------------+
+
+Open Bugs
+=====================================
+List any remaining open bugs. Ideally provide a short description and a
+link to the entry in JIRA
+
+**JIRA TICKETS:**
+
++--------------------------------------+--------------------------------------+
+| **JIRA REFERENCE** | **SLOGAN** |
+| | |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-86 | Need ability to specify number of |
+| | compute nodes |
++--------------------------------------+--------------------------------------+
\ No newline at end of file
--- /dev/null
+==============================================
+<Project Name> <Release Name> Compatibility
+==============================================
+
+
+Compatibility with Previous Releases
+=======================================
+<optional, required if there's a previous release>
+Is it compatible? Did anything about how a user or developer would
+consume it change? If so, document it here.
+
+Migration from Previous Releases
+=====================================
+<optional, required if there's a previous release for the project>
+
+Describe any special step somebody would have to take to migrate from a
+previous release to this one. If migration isn't supported for some
+combinations, state that as well.
\ No newline at end of file
--- /dev/null
+==============================================
+<Project Name> <Release Name> Deliverables
+==============================================
+
+
+Software Deliverables
+=======================================
+List out the software deliverables
+
+Documentation Deliverables
+=====================================
+Call out the documentation deliverables
\ No newline at end of file
--- /dev/null
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Ericsson AB and others.
+
+=============================================
+<Project Name> <Release Name> Release Notes
+=============================================
+
+Abstract
+===================
+Preface to what this document is about
+
+License
+=======
+Include Licensing information here
+
+Version History
+===============
+
+
++-------------+-----------+-----------------+----------------------+
+| **Date** | **Ver.** | **Authors** | **Comment** |
+| | | | |
++-------------+-----------+-----------------+----------------------+
+| YYYY-MM-DD | X.X.X | Name | Comments |
++-------------+-----------+-----------------+----------------------+
+| YYYY-MM-DD | X.X.X | Name | Comments |+-------------+-----------+-----------------+----------------------+
+| YYYY-MM-DD | X.X.X | Name | Comments |
++-------------+-----------+-----------------+----------------------+
+
+Contents
+===============
+
+.. toctree::
+ :maxdepth: 2
+
+ summary
+ version
+ compatibility
+ bugs
+ deliverables
+ scenario/index
+ references
--- /dev/null
+=============================================
+<Project Name> <Release Name> New Features
+=============================================
+
+
+Major Capabilities and Enhancements
+=====================================
+Provide information about the major capabilities this project provides
+in this release. Include those from previous release unless they have
+been deprecated or removed (see below).
+
+New Capabilities and Enhancements
+====================================
+Call out the new capabilities and/or enhancements that are present in
+this release, but were not present in prior releases.
+
+
++--------------------------------------+--------------------------------------+
+| **JIRA REFERENCE** | **SLOGAN** |
+| | |
++--------------------------------------+--------------------------------------+
+| JIRA: <XXXXXX> | Brief here |
++--------------------------------------+--------------------------------------+
--- /dev/null
+==============================================
+<Project Name> <Release Name> References
+==============================================
+
+List references
\ No newline at end of file
--- /dev/null
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) <optionally add copywriters name>
+
+
+=============================================
+<Scenario> <Release Name> Release Notes
+=============================================
+
+
+Introduction
+============
+.. In this section explain the purpose of the scenario and the types of capabilities provided
+
+Scenario components and composition
+===================================
+.. In this section describe the unique components that make up the scenario,
+.. what each component provides and why it has been included in order
+.. to communicate to the user the capabilities available in this scenario.
+
+Scenario usage overview
+=======================
+.. Provide a brief overview on how to use the scenario and the features available to the
+.. user. This should be an "introduction" to the userguide document, and explicitly link to it,
+.. where the specifics of the features are covered including examples and API's
+
+Limitations, Issues and Workarounds
+===================================
+.. Explain scenario limitations here, this should be at a design level rather than discussing
+.. faults or bugs. If the system design only provide some expected functionality then provide
+.. some insight at this point.
+
+References
+==========
+
+For more information on the OPNFV Colorado release, please visit
+http://www.opnfv.org/colorado
\ No newline at end of file
--- /dev/null
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Ericsson AB and others.
+
+=============================================
+<Release Name> Scenario Release Notes
+=============================================
+
+<Brief (Optional)>
+===================
+
+.. toctree::
+ :maxdepth: 2
+
+ <scenarioname>
--- /dev/null
+==============================================
+<Project Name> <Release Name> Version
+==============================================
+
+
+Module version changes
+========================
+List module level version changes
+
+
+Document Version Changes
+==========================
+Changes in documentation
\ No newline at end of file
--- /dev/null
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) <optionally add copywriters name>
+
+<Feature> description
+=====================
+.. Describe the specific features and how it is realised in the scenario in a brief manner
+.. to ensure the user understand the context for the user guide instructions to follow.
+
+<Feature> capabilities and usage
+================================
+.. Describe the specific capabilities and usage for <XYZ> feature.
+.. Provide enough information that a user will be able to operate the feature on a deployed scenario.
+
+<Feature and API usage guidelines and example>
+-----------------------------------------------
+.. Describe with examples how to use specific features, provide API examples and details required to
+.. operate the feature on the platform.
--- /dev/null
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) <optionally add copywriters name>
+
+=====================
+<feature> User Guide
+=====================
+
+.. The feature user guide should provide an OPNFV user with enough information to
+.. use the features provided by the feature project in the supported scenarios.
+.. This guide should walk a user through the usage of the features once a scenario
+.. has been deployed and is active according to the installation guide provided
+.. by the installer project.
+
+.. toctree::
+ :maxdepth: 2
+
+.. The feature.userguide.rst file should contain the text for this document
+.. additional documents can be added to this directory and added in the right order
+.. to this file as a list below.
+
+ ./feature.userguide.rst
+
--- /dev/null
+OPNFV Subrelease Guides
+=======================
+
+Apex
+-----
+.. toctree::
+ :maxdepth: 1
+
+ ../submodules/apex/docs/releasenotes/index
+ ../submodules/apex/docs/installationprocedure/index
+
+Compass
+--------
+.. toctree::
+ :maxdepth: 1
+
+ ../submodules/compass4nfv/docs/releasenotes/index
+ ../submodules/compass4nfv/docs/installationprocedure/index
+
+Fuel
+-----
+.. toctree::
+ :maxdepth: 1
+
+ ../submodules/fuel/docs/releasenotes/index
+ ../submodules/fuel/docs/installationprocedure/index
+
+Joid
+-----
+.. toctree::
+ :maxdepth: 1
+
+ ../submodules/joid/docs/releasenotes/index
+ ../submodules/joid/docs/installationprocedure/index
\ No newline at end of file
--- /dev/null
+Subproject commit ead4552c3344308b9620911c76a917de868ed2cb
--- /dev/null
+Subproject commit 2ce837eba9e229c6a974b6e71c91a1d658d4b3d7
--- /dev/null
+Subproject commit 593ef4f91ee0dac6cde4101b75174d88d0a01b28
--- /dev/null
+Subproject commit 32fc31642ff993fe93e5033cba9f97a633a0a340
--- /dev/null
+Subproject commit f61c75bab4c8c6c0b08765bef8b5f75e87db6565
--- /dev/null
+Subproject commit 3d090e6f939a95d1e50d819686712023bb1679e1
--- /dev/null
+Subproject commit d83a951249c6db8bcd1e959c3eb9ee4da798f355
--- /dev/null
+Subproject commit 3069bb6ec1937cefbcf24af4460b72f0915b22f1
--- /dev/null
+Subproject commit bfd645c60af3bdefae2984636fcb8aae1436b26f
--- /dev/null
+Subproject commit 7ad811e8d76d004cc55a7b4a4cc8637df260e42d
--- /dev/null
+Subproject commit d8a21638b012c5036ac1303d5fe055a73d8ff1b7
--- /dev/null
+Subproject commit 41ab8c8789a5407c2f8da6d72d0c97e4df1a9759
--- /dev/null
+Subproject commit bf21603087077733cdc1d3a757976685ed9bba3e
--- /dev/null
+Subproject commit 6963d16b32f0c40ea45be66bbd189d2d5bb070fb
--- /dev/null
+Subproject commit 5541131a92d2616e08daa9ea3374ff808d20ad4e
--- /dev/null
+Subproject commit cc19c9b3c5e62c6009e66abb035a5e678210c550
--- /dev/null
+Subproject commit 24c9ec0faf61f2f1b3cb0609209ea5d26cfe6f01
--- /dev/null
+Subproject commit ad77594f5846ebc4a28f52aa827db7e6c7970088
--- /dev/null
+Subproject commit b97b9be9fb62e7ddfbe31b7238b136a985c4411d
--- /dev/null
+Subproject commit 681905e8b5ec6885fed7e5e79901dc421df6a8be
--- /dev/null
+Subproject commit 9b0fde472adaae0605543ceb6432d200fc2380bc
--- /dev/null
+Subproject commit 09128148f036c4652df45eabf8781ef1684d2c23
--- /dev/null
+Subproject commit 75f93c362f8cde64b02e243d26bf9061f48adc34
--- /dev/null
+Subproject commit 754851249b5722222a84e5a821f6edea095e72e7
--- /dev/null
+Subproject commit d4df4c2e1637291e0246e24eb4f28da0a562f561
--- /dev/null
+Subproject commit 60dca59ac451300fae214776e82a068b2e8607da
--- /dev/null
+Subproject commit 28850f28aaa80cc71563f4c4698af70da6334f03
--- /dev/null
+Subproject commit a80ff748730bd3ee8c42b8f00f5c01ba8e41dd92
--- /dev/null
+Subproject commit 770cd4646f0ee1620592db4d3f4b7e2d41cd099e
--- /dev/null
+Subproject commit 5be83facc4d003b1d34afbd887865317cfdfd5ef
--- /dev/null
+Subproject commit 7f2bbc7c5913a39d49fdc6533c708939b47a9233
--- /dev/null
+Subproject commit 688948508e373829cdcd7bb1e4ebb7f55e43cdac
--- /dev/null
+Subproject commit fe63fc64c7a2b418875eafc271ed47c3155f2f3d
--- /dev/null
+Subproject commit 083ddad1d827e7a41c688bec76a957917cdc634c
--- /dev/null
+Subproject commit 38b1f656b4d3123b1f5a5fb612bc920a81cc4753
--- /dev/null
+Subproject commit 67f11688d3fae5bda97502d793198cfca2dbee13
--- /dev/null
+Subproject commit 4b652d4fce581014938483d24a9ec6e7a28b1632
--- /dev/null
+Subproject commit acf339f2840d0fe7a46187a0597704cf5b486214
--- /dev/null
+Subproject commit c5b07343a75f1a440721f66158e10965838ce194
--- /dev/null
+Subproject commit 3f4bdff540761f36659a847f0c12482efe26b00a
--- /dev/null
+Subproject commit c772a1dbc7ace58d099570d41a889adf851c8ba8
--- /dev/null
+Subproject commit 3d33e32f9fe9d8c8e6f4fb935d67fc39b2c0a483
--- /dev/null
+Subproject commit 96b30b364a0b88a15c38bd22883bb40bbcb6f428
Code Review / opnfvdocs.git / commitdiff
