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