summaryrefslogtreecommitdiffstats
path: root/docs/release-notes.rst
diff options
context:
space:
mode:
authorRich Bennett <rb2745@att.com>2017-10-13 15:28:09 -0400
committerRich Bennett <rb2745@att.com>2017-10-13 15:32:13 -0400
commitdd0f4438e8dea6ef68a043488545e3efcb3fa78a (patch)
treeced34525665cc8c4b35a79c0ee7a50290c60240c /docs/release-notes.rst
parent0e89c1fbeb6618a1a4218c7c78506dff6f71dd6d (diff)
Minor edits to resturcture text documentation
Improved cross references, bullet lists, and used code-block directive on bash cmds Added release-notes template Change-Id: Id12fb1b77ef9690b5b50505e47ec7035039f2f24 Issue-ID: CLI-54 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 00000000..39389326
--- /dev/null
+++ b/docs/release-notes.rst
@@ -0,0 +1,48 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+CLI 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