summaryrefslogtreecommitdiffstats
path: root/docs/release-notes.rst
diff options
context:
space:
mode:
authorRich Bennett <rb2745@att.com>2017-10-16 09:25:01 -0400
committerRich Bennett <rb2745@att.com>2017-10-16 09:31:27 -0400
commit4b00193d6ad8fcc99c5625ede8de07b72ae1c697 (patch)
tree50834a826544ec43cacab94543b9e9d3411c46d5 /docs/release-notes.rst
parent7fe52deb89467c1bb0e7f2a43f4092903b1d0021 (diff)
Update toctree to current release notes template
Change-Id: I0864d9e3c46aae885473a18fa21eab205a352eff Issue-ID: SDC-419 Signed-off-by: Rich Bennett <rb2745@att.com>
Diffstat (limited to 'docs/release-notes.rst')
-rw-r--r--docs/release-notes.rst48
1 files changed, 48 insertions, 0 deletions
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
new file mode 100644
index 0000000000..b568bee821
--- /dev/null
+++ b/docs/release-notes.rst
@@ -0,0 +1,48 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+Release Notes
+=============
+
+.. note::
+ * This Release Notes must be updated each time the team decides to Release new artifacts.
+ * The scope of this Release Notes is for this particular component. In other words, each ONAP component has its Release Notes.
+ * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of this Release Notes.
+ * Except the date and the version number, all the other sections are optional but there must be at least one section describing the purpose of this new release.
+ * This note must be removed after content has been added.
+
+
+Version: x.y.z
+--------------
+
+
+:Release Date: yyyy-mm-dd
+
+
+
+**New Features**
+
+One or two sentences explaining the purpose of this Release.
+
+**Bug Fixes**
+ - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and a sentence explaining what this defect is addressing.
+**Known Issues**
+ - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and two, three sentences.
+ One sentences explaining what is the issue.
+
+ Another sentence explaining the impact of the issue.
+
+ And an optional sentence providing a workaround.
+
+**Security Issues**
+ You may want to include a reference to CVE (Common Vulnerabilities and Exposures) `CVE <https://cve.mitre.org>`_
+
+
+**Upgrade Notes**
+
+**Deprecation Notes**
+
+**Other**
+
+===========
+
+End of Release Notes