From c58f8465744f092963c013b101cf6972d481b254 Mon Sep 17 00:00:00 2001 From: Rich Bennett Date: Tue, 24 Oct 2017 08:26:42 -0400 Subject: Add architecture and release notes structure Add release-notes template Move Clamp in ONAP Architecture description a separate file Add seperator lines on list items Issue-ID: DOC-110 Change-Id: Ibe803f4de3d4641b54ff4c2df54c5c3af62e4afc Signed-off-by: Rich Bennett --- docs/release-notes.rst | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 docs/release-notes.rst (limited to 'docs/release-notes.rst') diff --git a/docs/release-notes.rst b/docs/release-notes.rst new file mode 100644 index 00000000..b568bee8 --- /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 `_ and a sentence explaining what this defect is addressing. +**Known Issues** + - `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 `_ + + +**Upgrade Notes** + +**Deprecation Notes** + +**Other** + +=========== + +End of Release Notes -- cgit 1.2.3-korg