summaryrefslogtreecommitdiffstats
path: root/docs/templates/release/release-notes
diff options
context:
space:
mode:
Diffstat (limited to 'docs/templates/release/release-notes')
-rw-r--r--docs/templates/release/release-notes/index.rst6
-rw-r--r--docs/templates/release/release-notes/release-notes.rst20
2 files changed, 13 insertions, 13 deletions
diff --git a/docs/templates/release/release-notes/index.rst b/docs/templates/release/release-notes/index.rst
index a0759f77f..e703944ef 100644
--- a/docs/templates/release/release-notes/index.rst
+++ b/docs/templates/release/release-notes/index.rst
@@ -1,9 +1,9 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-==================================================
-OPNFV <Project Name> Release Notes
-==================================================
+****************************
+<Project Name> Release Notes
+****************************
.. toctree::
:maxdepth: 1
diff --git a/docs/templates/release/release-notes/release-notes.rst b/docs/templates/release/release-notes/release-notes.rst
index ad6759b08..ead095cc3 100644
--- a/docs/templates/release/release-notes/release-notes.rst
+++ b/docs/templates/release/release-notes/release-notes.rst
@@ -1,9 +1,6 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-======================================================================
-OPNFV <Project Name> Release Notes
-======================================================================
This document provides the release notes for <RELEASE> of <COMPONENT>.
@@ -13,7 +10,7 @@ This document provides the release notes for <RELEASE> of <COMPONENT>.
Version history
-------------------
+---------------
+--------------------+--------------------+--------------------+--------------------+
| **Date** | **Ver.** | **Author** | **Comment** |
@@ -30,7 +27,7 @@ Version history
+--------------------+--------------------+--------------------+--------------------+
Important notes
------------------
+===============
<STATE IMPORTANT NOTES/DEVIATIONS SINCE PREVIOUS ITERATIVE RELEASE AND OTHER IMPORTANT NOTES FOR THIS RELEASE>
@@ -39,8 +36,9 @@ Important notes
**Attention:** Please be aware that since LSV3 a pre-deploy script must be ran on the Fuel master -
see the OPNFV@Fuel SW installation instructions
+
Summary
-------------
+=======
<SUMMARIZE THE RELEASE - THE CONTENT - AND OTHER IMPORTANT HIGH LEVEL PROPERTIES>
@@ -49,8 +47,9 @@ Summary
Arno Fuel@OPNFV is based the OpenStack Fuel upstream project version 6.0.1,
but adds OPNFV unique components such as OpenDaylight version: Helium as well as other OPNFV unique configurations......
+
Release Data
----------------
+============
<STATE RELEVANT RELEASE DATA/RECORDS>
<EXAMPLE>:
@@ -147,8 +146,9 @@ Documentation deliverables
<EXAMPLE>:
+
Known Limitations, Issues and Workarounds
---------------------------------------------
+=========================================
System Limitations
^^^^^^^^^^^^^^^^^^^^
@@ -198,7 +198,7 @@ Workarounds
- In case the disk is full on a controller - delete all files in /tmp
Test Result
----------------
+===========
<STATE THE QA COVERAGE AND RESULTS>
<EXAMPLE>:
@@ -223,7 +223,7 @@ Fuel@OPNFV Arno RC2 has undergone QA test runs with the following results:
+--------------------------------------+--------------------------------------+
References
-------------
+==========
<STATE RELEVANT REFERENCES FOR THIS RELEASE/VERSION>
<EXAMPLE>: