docs/release-notes.rst

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