From: rn509j Date: Mon, 6 Nov 2017 16:50:44 +0000 (-0500) Subject: Adding release notes X-Git-Tag: v1.0.1~2 X-Git-Url: https://gerrit.onap.org/r/gitweb?a=commitdiff_plain;h=2200acabadd8ceb05ff36baebb2c0f735e5d150c;p=dmaap%2Fmessagerouter%2Fmessageservice.git Adding release notes DMAAP-168 Signed-off-by: rn509j Change-Id: I058f4e46e4bae89ef569d19e0b143364fd579e60 --- diff --git a/docs/release-notes.rst b/docs/release-notes.rst new file mode 100644 index 0000000..4502fbf --- /dev/null +++ b/docs/release-notes.rst @@ -0,0 +1,46 @@ +.. 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** + +===========