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 | **Release date**                     | <DD/MM/YYYY>                         |
  46 |                                      |                                      |
  47 +--------------------------------------+--------------------------------------+
  48
  49 New features
  50 ------------
  51
  52 <Describe new features or other new additions>
  53
  54 **Bug fixes**
  55
  56 - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and a sentence explaining
  57   what this defect is addressing.
  58
  59 **Known Issues**
  60
  61 - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and two to three sentences
  62   explaining what this issue is.
  63
  64 Deliverables
  65 ------------
  66
  67 Software Deliverables
  68 ~~~~~~~~~~~~~~~~~~~~~
  69
  70
  71 Documentation Deliverables
  72 ~~~~~~~~~~~~~~~~~~~~~~~~~~
  73
  74
  75 Known Limitations, Issues and Workarounds
  76 =========================================
  77
  78 System Limitations
  79 ------------------
  80
  81 Any known system limitations.
  82
  83
  84 Known Vulnerabilities
  85 ---------------------
  86
  87 Results of know vulnerabilities analysis in used modules.
  88
  89
  90 Workarounds
  91 -----------
  92
  93 Any known workarounds.
  94
  95
  96 Security Notes
  97 --------------
  98
  99 **Fixed Security Issues**
 100
 101 List of security issues fixed in this release including CVEs and OJSI
 102 tickets.
 103
 104 **Known Security Issues**
 105
 106 List of new security issues that are left unfixed in this release including
 107 CVEs and OJSI tickets.
 108
 109
 110 Test Results
 111 ============
 112 List or refer to any project specific results
 113
 114
 115 References
 116 ==========
 117
 118 For more information on the ONAP ``<release name>`` release, please see:
 119
 120 #. `ONAP Home Page`_
 121 #. `ONAP Documentation`_
 122 #. `ONAP Release Downloads`_
 123 #. `ONAP Wiki Page`_
 124
 125
 126 .. _`ONAP Home Page`: https://www.onap.org
 127 .. _`ONAP Wiki Page`: https://wiki.onap.org
 128 .. _`ONAP Documentation`: https://docs.onap.org
 129 .. _`ONAP Release Downloads`: https://git.onap.org