diff options
| author |   Sofia Wallin <sofia.wallin@est.tech> | 2020-04-09 13:27:17 +0200 |
|---|---|---|
| committer | Sofia Wallin <sofia.wallin@est.tech> | 2020-04-20 14:36:58 +0200 |
| commit | 15af815d914fb4de45fc5952fe12b7c4750fb0c8 (patch) | |
| tree | 002d298b7b0e70762241d10dc64eeba5c6158e0a /docs/templates/sections | |
| parent | 71817e0446f5186a1ca905be7b2cf40d13efe44e (diff) | |
Clarified release note
Clarified sections in the release note template
based on feedback given in the PTL call
Issue-ID: DOC-575
Signed-off-by: Sofia Wallin <sofia.wallin@est.tech>
Change-Id: Ie7fa510de5b23712349853a5d1164ac54e13645d
Diffstat (limited to 'docs/templates/sections')
| -rw-r--r-- | docs/templates/sections/release-notes.rst | 46 |
1 files changed, 40 insertions, 6 deletions
diff --git a/docs/templates/sections/release-notes.rst b/docs/templates/sections/release-notes.rst index 238b70baf..980d59a4d 100644 --- a/docs/templates/sections/release-notes.rst +++ b/docs/templates/sections/release-notes.rst @@ -1,4 +1,5 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. This work is licensed under a Creative Commons Attribution 4.0 + International License. .. http://creativecommons.org/licenses/by/4.0 .. (c) ONAP Project and its contributors @@ -6,6 +7,13 @@ <project> Release Notes *********************** +.. note:: + * The release note needs to be updated for each ONAP release + * Except the section "Release data" all other sections are optional and should be + applied where applicable + * Only the current release is to be documented in this document + * This note needs to be removed before publishing the final result + Abstract ======== @@ -14,25 +22,26 @@ This document provides the release notes for the ``<releasename>`` release. Summary ======= -<Give a high level description of your project with regards to this specific release> +<Give a high level description of your project with regards to this +specific release> Release Data ============ +--------------------------------------+--------------------------------------+ -| **Project** | | +| **Project** | <project name> | | | | +--------------------------------------+--------------------------------------+ -| **Docker images** | make sure you include all docker | +| **Docker images** | make sure you include all docker | | | images including the | | | release version | | | | +--------------------------------------+--------------------------------------+ -| **Release designation** | | +| **Release designation** | <release name followed by version> | | | | +--------------------------------------+--------------------------------------+ -| **Release date** | | +| **Release date** | <DD/MM/YYYY> | | | | +--------------------------------------+--------------------------------------+ @@ -41,6 +50,15 @@ New features <Describe new features or other new additions> +**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 to three sentences + explaining what this issue is. Deliverables ------------ @@ -59,18 +77,34 @@ Known Limitations, Issues and Workarounds System Limitations ------------------ +Any known system limitations. + Known Vulnerabilities --------------------- +Results of know vulnerabilities analysis in used modules. + Workarounds ----------- +Any known workarounds. + Security Notes -------------- +**Fixed Security Issues** + +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. + Test Results ============ |