X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Ftemplates%2Fsections%2Frelease-notes.rst;h=df6176029f206731078d2aa236ac6aef458a2649;hb=fcd3a157297d10a88e3b735b5e68729838d2b83f;hp=ca257314e85dbeac88ee8a19261bdb15738d530a;hpb=1f6cac44fa61db99bc530ca6513bfdccf3cc23e5;p=doc.git diff --git a/docs/templates/sections/release-notes.rst b/docs/templates/sections/release-notes.rst index ca257314e..df6176029 100644 --- a/docs/templates/sections/release-notes.rst +++ b/docs/templates/sections/release-notes.rst @@ -1,14 +1,16 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + 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. + * 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 @@ -24,18 +26,28 @@ Version: x.y.z One or two sentences explaining the purpose of this Release. **Bug Fixes** - - `CIMAN-65 `_ and a sentence explaining what this defect is addressing. + - `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. + - `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 Notes** + +*Fixed Security Issues* -**Security Issues** - You may want to include a reference to CVE (Common Vulnerabilities and Exposures) `CVE `_ + List of security issues fixed in this release including CVEs and OJSI tickets. +*Known Security Issues* + + List of new security issues that are left unfixed in this release including CVEs and OJSI tickets. + +*Known Vulnerabilities in Used Modules* + + Results of know vulnerabilities analysis in used modules. **Upgrade Notes** @@ -44,3 +56,5 @@ One or two sentences explaining the purpose of this Release. **Other** =========== + +End of Release Notes