.. http://creativecommons.org/licenses/by/4.0
+Release-notes
+=============
+
+
This document provides the release notes for <RELEASE> of <COMPONENT>.
.. contents::
Summary
-=======
+-------
<SUMMARIZE THE RELEASE - THE CONTENT - AND OTHER IMPORTANT HIGH LEVEL PROPERTIES>
Release Data
-============
+------------
<STATE RELEVANT RELEASE DATA/RECORDS>
<EXAMPLE>:
+--------------------------------------+--------------------------------------+
-| **Project** | E.g. Arno/genesis/fuel@opnfv |
+| **Project** | E.g. project |
| | |
+--------------------------------------+--------------------------------------+
| **Repo/commit-ID** | E.g. genesis/adf634a0d4..... |
| **Release date** | E.g. 2015-04-16 |
| | |
+--------------------------------------+--------------------------------------+
-| **Purpose of the delivery** | E.g. OPNFV Internal quality assurance|
+| **Purpose of the delivery** | |
| | |
+--------------------------------------+--------------------------------------+
Feature additions
-~~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^
<STATE ADDED FEATURES BY REFERENCE TO JIRA>
<EXAMPLE>:
+--------------------------------------+--------------------------------------+
Bug corrections
-~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^
**JIRA TICKETS:**
+--------------------------------------+--------------------------------------+
Deliverables
-----------------
+^^^^^^^^^^^^
Software deliverables
-^^^^^^^^^^^^^^^^^^^^^^^
++++++++++++++++++++++
<STATE WHAT SOFTWARE DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
-<EXAMPLE>:
+
Documentation deliverables
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+++++++++++++++++++++++++++
<STATE WHAT DOCUMENTATION DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
-<EXAMPLE>:
+
Known Limitations, Issues and Workarounds
-=========================================
+-----------------------------------------
System Limitations
-^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^
<STATE ALL RELEVANT SYSTEM LIMITATIONS, IF THERE IS ANY>
Known issues
-^^^^^^^^^^^^^^^
+^^^^^^^^^^^^
<STATE ALL KNOWN ISSUES WITH JIRA REFERENCE>
<EXAMPLE>:
+--------------------------------------+--------------------------------------+
Workarounds
-^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^
<STATE ALL KNOWN WORKAROUNDS TO THE ISSUES STATED ABOVE, IF THERE IS ANY>
References
-==========
+----------
<STATE RELEVANT REFERENCES FOR THIS RELEASE/VERSION>
--- /dev/null
+# documentation only
+[tox]
+minversion = 2.0
+envlist =
+ docs,
+ docs-linkcheck,
+skipsdist = true
+
+[testenv:docs]
+basepython = python3
+deps =
+ sphinx
+ sphinx-rtd-theme
+ sphinxcontrib-httpdomain
+ recommonmark
+ lfdocs-conf
+
+commands =
+ sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
+ echo "Generated docs available in {toxinidir}/docs/_build/html"
+whitelist_externals = echo
+
+[testenv:docs-linkcheck]
+basepython = python3
+deps = sphinx
+ sphinx-rtd-theme
+ sphinxcontrib-httpdomain
+ recommonmark
+ lfdocs-conf
+commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
+
--- /dev/null
+[tox]
+minversion = 2.0
+envlist =
+ docs,
+ docs-linkcheck,
+
+skipsdist = true
+
+[testenv:docs]
+basepython = python3
+deps =
+ sphinx
+ sphinx-rtd-theme
+ sphinxcontrib-httpdomain
+ recommonmark
+ lfdocs-conf
+
+commands =
+ sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
+
+ echo "Generated docs available in {toxinidir}/docs/_build/html"
+
+whitelist_externals = echo
+
+[testenv:docs-linkcheck]
+basepython = python3
+deps = sphinx
+ sphinx-rtd-theme
+ sphinxcontrib-httpdomain
+ recommonmark
+ lfdocs-conf
+commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck