docs/templates/sections/release-notes.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. (c) ONAP Project and its contributors
   4
   5 ***********************
   6 <project> Release Notes
   7 ***********************
   8
   9 Abstract
  10 ========
  11
  12 This document provides the release notes for the ``<releasename>`` release.
  13
  14 Summary
  15 =======
  16
  17 <Give a high level description of your project with regards to this specific release>
  18
  19
  20 Release Data
  21 ============
  22
  23 +--------------------------------------+--------------------------------------+
  24 | **Project**                          |                                      |
  25 |                                      |                                      |
  26 +--------------------------------------+--------------------------------------+
  27 | **Docker images**                    | make sure you include all docker     |
  28 |                                      |  images including the                |
  29 |                                      |  release version                     |
  30 |                                      |                                      |
  31 +--------------------------------------+--------------------------------------+
  32 | **Release designation**              |                                      |
  33 |                                      |                                      |
  34 +--------------------------------------+--------------------------------------+
  35 | **Release date**                     |                                      |
  36 |                                      |                                      |
  37 +--------------------------------------+--------------------------------------+
  38
  39 New features
  40 ------------
  41
  42 <Describe new features or other new additions>
  43
  44
  45 Deliverables
  46 ------------
  47
  48 Software Deliverables
  49 ~~~~~~~~~~~~~~~~~~~~~
  50
  51
  52 Documentation Deliverables
  53 ~~~~~~~~~~~~~~~~~~~~~~~~~~
  54
  55
  56 Known Limitations, Issues and Workarounds
  57 =========================================
  58
  59 System Limitations
  60 ------------------
  61
  62
  63 Known Vulnerabilities
  64 ---------------------
  65
  66
  67 Workarounds
  68 -----------
  69
  70
  71 Security Notes
  72 --------------
  73
  74
  75 Test Results
  76 ============
  77 List or refer to any project specific results
  78
  79
  80 References
  81 ==========
  82
  83 For more information on the ONAP ``<release name>`` release, please see:
  84
  85 #. `ONAP Home Page`_
  86 #. `ONAP Documentation`_
  87 #. `ONAP Release Downloads`_
  88 #. `ONAP Wiki Page`_
  89
  90
  91 .. _`ONAP Home Page`: https://www.onap.org
  92 .. _`ONAP Wiki Page`: https://wiki.onap.org
  93 .. _`ONAP Documentation`: https://docs.onap.org
  94 .. _`ONAP Release Downloads`: https://git.onap.org