docs/templates/sections/release-notes.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0
   2    International License.
   3 .. http://creativecommons.org/licenses/by/4.0
   4 .. (c) ONAP Project and its contributors
   5
   6 ***********************
   7 <project> Release Notes
   8 ***********************
   9
  10 .. note::
  11    * The release note needs to be updated for each ONAP release
  12    * Except the section "Release data" all other sections are optional and should be
  13      applied where applicable
  14    * Only the current release is to be documented in this document
  15    * This note needs to be removed before publishing the final result
  16
  17 Abstract
  18 ========
  19
  20 This document provides the release notes for the ``<releasename>`` release.
  21
  22 Summary
  23 =======
  24
  25 <Give a high level description of your project with regards to this
  26 specific release>
  27
  28
  29 Release Data
  30 ============
  31
  32 +--------------------------------------+--------------------------------------+
  33 | **Project**                          | <project name>                       |
  34 |                                      |                                      |
  35 +--------------------------------------+--------------------------------------+
  36 | **Docker images**                    |  make sure you include all docker    |
  37 |                                      |  images including the                |
  38 |                                      |  release version                     |
  39 |                                      |                                      |
  40 +--------------------------------------+--------------------------------------+
  41 | **Release designation**              | <release name followed by version>   |
  42 |                                      |                                      |
  43 +--------------------------------------+--------------------------------------+
  44 | **Release date**                     | <DD/MM/YYYY>                         |
  45 |                                      |                                      |
  46 +--------------------------------------+--------------------------------------+
  47
  48 New features
  49 ------------
  50
  51 <Describe new features or other new additions>
  52
  53 **Bug fixes**
  54
  55 - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and a sentence explaining
  56   what this defect is addressing.
  57
  58 **Known Issues**
  59
  60 - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and two to three sentences
  61   explaining what this issue is.
  62
  63 Deliverables
  64 ------------
  65
  66 Software Deliverables
  67 ~~~~~~~~~~~~~~~~~~~~~
  68
  69
  70 Documentation Deliverables
  71 ~~~~~~~~~~~~~~~~~~~~~~~~~~
  72
  73
  74 Known Limitations, Issues and Workarounds
  75 =========================================
  76
  77 System Limitations
  78 ------------------
  79
  80 Any known system limitations.
  81
  82
  83 Known Vulnerabilities
  84 ---------------------
  85
  86 Results of know vulnerabilities analysis in used modules.
  87
  88
  89 Workarounds
  90 -----------
  91
  92 Any known workarounds.
  93
  94
  95 Security Notes
  96 --------------
  97
  98 **Fixed Security Issues**
  99
 100 List of security issues fixed in this release including CVEs and OJSI
 101 tickets.
 102
 103 **Known Security Issues**
 104
 105 List of new security issues that are left unfixed in this release including
 106 CVEs and OJSI tickets.
 107
 108
 109 Test Results
 110 ============
 111 List or refer to any project specific results
 112
 113
 114 References
 115 ==========
 116
 117 For more information on the ONAP ``<release name>`` release, please see:
 118
 119 #. `ONAP Home Page`_
 120 #. `ONAP Documentation`_
 121 #. `ONAP Release Downloads`_
 122 #. `ONAP Wiki Page`_
 123
 124
 125 .. _`ONAP Home Page`: https://www.onap.org
 126 .. _`ONAP Wiki Page`: https://wiki.onap.org
 127 .. _`ONAP Documentation`: https://docs.onap.org
 128 .. _`ONAP Release Downloads`: https://git.onap.org