docs/release-notes/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) <optionally add copywriters name>
   4
   5 =================================================
   6 Release Note for the Brahmaputra release of OPNFV
   7 =================================================
   8
   9 .. toctree::
  10    :maxdepth: 2
  11
  12 Abstract
  13 ========
  14
  15 This document compiles the release notes for the Brahmaputra release of
  16 OPNFV when using <XYZ> as a deployment tool.
  17
  18 Introduction
  19 ============
  20
  21 Provide a breif introduction of how this release is used in OPNFV relese using <XYZ> as a deployment tool
  22
  23 Be sure to reference your installation-instructions.
  24
  25 Release Data
  26 ============
  27
  28 +--------------------------------------+--------------------------------------+
  29 | **Project**                          |                                      |
  30 |                                      |                                      |
  31 +--------------------------------------+--------------------------------------+
  32 | **Repo/tag**                         |                                      |
  33 |                                      |                                      |
  34 +--------------------------------------+--------------------------------------+
  35 | **Release designation**              |                                      |
  36 |                                      |                                      |
  37 +--------------------------------------+--------------------------------------+
  38 | **Release date**                     |                                      |
  39 |                                      |                                      |
  40 +--------------------------------------+--------------------------------------+
  41 | **Purpose of the delivery**          |                                      |
  42 |                                      |                                      |
  43 +--------------------------------------+--------------------------------------+
  44
  45 Deliverables
  46 ------------
  47
  48 Software deliverables
  49 ~~~~~~~~~~~~~~~~~~~~~
  50 <XYZ>-based installer iso file <iso file version>
  51
  52 Documentation deliverables
  53 ~~~~~~~~~~~~~~~~~~~~~~~~~~
  54 -
  55
  56 Version change
  57 --------------
  58 .. This section describes the changes made since the last version of this document.
  59
  60 Module version change
  61 ~~~~~~~~~~~~~~~~~~~~~
  62
  63 Document version change
  64 ~~~~~~~~~~~~~~~~~~~~~~~
  65
  66 Reason for new version
  67 ----------------------
  68
  69 Feature additions
  70 ~~~~~~~~~~~~~~~~~
  71
  72 +--------------------------------------+--------------------------------------+
  73 | **JIRA REFERENCE**                   | **SLOGAN**                           |
  74 |                                      |                                      |
  75 +--------------------------------------+--------------------------------------+
  76 | JIRA:                                |                                      |
  77 |                                      |                                      |
  78 +--------------------------------------+--------------------------------------+
  79 | JIRA:                                |                                      |
  80 |                                      |                                      |
  81 +--------------------------------------+--------------------------------------+
  82
  83 Bug corrections
  84 ~~~~~~~~~~~~~~~
  85
  86 **JIRA TICKETS:**
  87
  88 +--------------------------------------+--------------------------------------+
  89 | **JIRA REFERENCE**                   | **SLOGAN**                           |
  90 |                                      |                                      |
  91 +--------------------------------------+--------------------------------------+
  92 | JIRA:                                |                                      |
  93 |                                      |                                      |
  94 +--------------------------------------+--------------------------------------+
  95
  96
  97 Known Limitations, Issues and Workarounds
  98 =========================================
  99
 100 System Limitations
 101 ------------------
 102
 103 Known issues
 104 ------------
 105
 106 **JIRA TICKETS:**
 107
 108 +--------------------------------------+--------------------------------------+
 109 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 110 |                                      |                                      |
 111 +--------------------------------------+--------------------------------------+
 112 | JIRA:                                |                                      |
 113 +--------------------------------------+--------------------------------------+
 114 | JIRA:                                |                                      |
 115 +--------------------------------------+--------------------------------------+
 116
 117
 118 Workarounds
 119 -----------
 120 See JIRA: <link>
 121
 122
 123 Test Result
 124 ===========
 125 Brahmaputra test result using <XYZ> as deployment tool.
 126 <link>
 127
 128 References
 129 ==========
 130 For more information on the OPNFV Brahmaputra release, please visit
 131 http://www.opnfv.org/brahmaputra
 132