docs/release-notes.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. SPDX-License-Identifier: CC-BY-4.0
   3 .. ===============LICENSE_START=======================================================
   4 .. Copyright (C) 2019 AT&T Intellectual Property
   5 .. ===================================================================================
   6 .. This documentation file is distributed under the Creative Commons Attribution
   7 .. 4.0 International License (the "License"); you may not use this file except in
   8 .. compliance with the License.  You may obtain a copy of the License at
   9 ..
  10 .. http://creativecommons.org/licenses/by/4.0
  11 ..
  12 .. This file is distributed on an "AS IS" BASIS,
  13 .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 .. See the License for the specific language governing permissions and
  15 .. limitations under the License.
  16 .. ===============LICENSE_END=========================================================
  17
  18
  19 This document provides the release notes for <RELEASE> of <COMPONENT>.
  20
  21 .. contents::
  22    :depth: 3
  23    :local:
  24
  25
  26 Version history
  27 ---------------
  28
  29 +--------------------+--------------------+--------------------+--------------------+
  30 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
  31 |                    |                    |                    |                    |
  32 +--------------------+--------------------+--------------------+--------------------+
  33 | 20XX-XX-XX         | 0.1.0              |                    | First draft        |
  34 |                    |                    |                    |                    |
  35 +--------------------+--------------------+--------------------+--------------------+
  36 |                    | 0.1.1              |                    |                    |
  37 |                    |                    |                    |                    |
  38 +--------------------+--------------------+--------------------+--------------------+
  39 |                    | 1.0                |                    |                    |
  40 |                    |                    |                    |                    |
  41 +--------------------+--------------------+--------------------+--------------------+
  42
  43
  44 Summary
  45 =======
  46
  47 <SUMMARIZE THE RELEASE - THE CONTENT - AND OTHER IMPORTANT HIGH LEVEL PROPERTIES>
  48
  49
  50
  51
  52 Release Data
  53 ============
  54 <STATE RELEVANT RELEASE DATA/RECORDS>
  55
  56 <EXAMPLE>:
  57
  58 +--------------------------------------+--------------------------------------+
  59 | **Project**                          | E.g. Arno/genesis/fuel@opnfv         |
  60 |                                      |                                      |
  61 +--------------------------------------+--------------------------------------+
  62 | **Repo/commit-ID**                   | E.g. genesis/adf634a0d4.....         |
  63 |                                      |                                      |
  64 +--------------------------------------+--------------------------------------+
  65 | **Release designation**              | E.g. Arno RC2                        |
  66 |                                      |                                      |
  67 +--------------------------------------+--------------------------------------+
  68 | **Release date**                     | E.g. 2015-04-16                      |
  69 |                                      |                                      |
  70 +--------------------------------------+--------------------------------------+
  71 | **Purpose of the delivery**          | E.g. OPNFV Internal quality assurance|
  72 |                                      |                                      |
  73 +--------------------------------------+--------------------------------------+
  74
  75
  76
  77
  78 Feature additions
  79 -------------------
  80 <STATE ADDED FEATURES BY REFERENCE TO JIRA>
  81
  82 <EXAMPLE>:
  83
  84 **JIRA BACK-LOG:**
  85
  86 +--------------------------------------+--------------------------------------+
  87 | **JIRA REFERENCE**                   | **SLOGAN**                           |
  88 |                                      |                                      |
  89 +--------------------------------------+--------------------------------------+
  90 |                                      |                                      |
  91 |                                      |                                      |
  92 |                                      |                                      |
  93 +--------------------------------------+--------------------------------------+
  94 |                                      |                                      |
  95 |                                      |                                      |
  96 |                                      |                                      |
  97 +--------------------------------------+--------------------------------------+
  98
  99 Bug corrections
 100 ----------------
 101
 102 **JIRA TICKETS:**
 103
 104 +--------------------------------------+--------------------------------------+
 105 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 106 |                                      |                                      |
 107 +--------------------------------------+--------------------------------------+
 108 |                                      |                                      |
 109 |                                      |                                      |
 110 |                                      |                                      |
 111 +--------------------------------------+--------------------------------------+
 112 |                                      |                                      |
 113 |                                      |                                      |
 114 |                                      |                                      |
 115 +--------------------------------------+--------------------------------------+
 116
 117 Deliverables
 118 ============
 119
 120 <Deliverables>
 121
 122
 123 Software deliverables
 124 ---------------------
 125
 126 <STATE WHAT SOFTWARE DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
 127
 128 <EXAMPLE>:
 129
 130 Documentation deliverables
 131 ---------------------------
 132
 133 <STATE WHAT DOCUMENTATION DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
 134
 135 <EXAMPLE>:
 136
 137
 138 Known Limitations, Issues and Workarounds
 139 =========================================
 140
 141 System Limitations
 142 ------------------
 143 <STATE ALL RELEVANT SYSTEM LIMITATIONS, IF THERE IS ANY>
 144
 145
 146
 147 Known issues
 148 ------------------
 149 <STATE ALL KNOWN ISSUES WITH JIRA REFERENCE>
 150
 151 <EXAMPLE>:
 152
 153 **JIRA TICKETS:**
 154
 155 +--------------------------------------+--------------------------------------+
 156 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 157 |                                      |                                      |
 158 +--------------------------------------+--------------------------------------+
 159 |                                      |                                      |
 160 |                                      |                                      |
 161 |                                      |                                      |
 162 +--------------------------------------+--------------------------------------+
 163 |                                      |                                      |
 164 |                                      |                                      |
 165 |                                      |                                      |
 166 +--------------------------------------+--------------------------------------+
 167
 168 Workarounds
 169 ------------------
 170
 171 <STATE ALL KNOWN WORKAROUNDS TO THE ISSUES STATED ABOVE, IF THERE IS ANY>
 172
 173
 174
 175
 176 References
 177 ==========
 178 <STATE RELEVANT REFERENCES FOR THIS RELEASE/VERSION>
 179
 180
 181
 182