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 E2 Terminator Release Notes
  20 ============================================================================================
  21 The following is a list of release highlights for E2 Terminator:
  22
  23 2019 October 31; version 2.0.7.5
  24 --------------------------------------------------------------------------------------------
  25 The following flows are supported:
  26 - ENDC Setup
  27 - X2 Setup
  28 - ENDC Configuration Update
  29 - X2 Configuration Update
  30 - Reset
  31 - Shutdown
  32 - Load Information
  33
  34
  35 Version history
  36 ---------------
  37
  38 +--------------------+--------------------+--------------------+--------------------+
  39 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
  40 |                    |                    |                    |                    |
  41 +--------------------+--------------------+--------------------+--------------------+
  42 | 20XX-XX-XX         | 0.1.0              |                    | First draft        |
  43 |                    |                    |                    |                    |
  44 +--------------------+--------------------+--------------------+--------------------+
  45 |                    | 0.1.1              |                    |                    |
  46 |                    |                    |                    |                    |
  47 +--------------------+--------------------+--------------------+--------------------+
  48 |                    | 1.0                |                    |                    |
  49 |                    |                    |                    |                    |
  50 +--------------------+--------------------+--------------------+--------------------+
  51
  52
  53 Summary
  54 =======
  55
  56 <SUMMARIZE THE RELEASE - THE CONTENT - AND OTHER IMPORTANT HIGH LEVEL PROPERTIES>
  57
  58
  59
  60
  61 Release Data
  62 ============
  63 <STATE RELEVANT RELEASE DATA/RECORDS>
  64
  65 <EXAMPLE>:
  66
  67 +--------------------------------------+--------------------------------------+
  68 | **Project**                          | E.g. Arno/genesis/fuel@opnfv         |
  69 |                                      |                                      |
  70 +--------------------------------------+--------------------------------------+
  71 | **Repo/commit-ID**                   | E.g. genesis/adf634a0d4.....         |
  72 |                                      |                                      |
  73 +--------------------------------------+--------------------------------------+
  74 | **Release designation**              | E.g. Arno RC2                        |
  75 |                                      |                                      |
  76 +--------------------------------------+--------------------------------------+
  77 | **Release date**                     | E.g. 2015-04-16                      |
  78 |                                      |                                      |
  79 +--------------------------------------+--------------------------------------+
  80 | **Purpose of the delivery**          | E.g. OPNFV Internal quality assurance|
  81 |                                      |                                      |
  82 +--------------------------------------+--------------------------------------+
  83
  84
  85
  86
  87 Feature additions
  88 ~~~~~~~~~~~~~~~~~~~~~~~
  89 <STATE ADDED FEATURES BY REFERENCE TO JIRA>
  90
  91 <EXAMPLE>:
  92
  93 **JIRA BACK-LOG:**
  94
  95 +--------------------------------------+--------------------------------------+
  96 | **JIRA REFERENCE**                   | **SLOGAN**                           |
  97 |                                      |                                      |
  98 +--------------------------------------+--------------------------------------+
  99 |                                      |                                      |
 100 |                                      |                                      |
 101 |                                      |                                      |
 102 +--------------------------------------+--------------------------------------+
 103 |                                      |                                      |
 104 |                                      |                                      |
 105 |                                      |                                      |
 106 +--------------------------------------+--------------------------------------+
 107
 108 Bug corrections
 109 ~~~~~~~~~~~~~~~~~~~~~
 110
 111 **JIRA TICKETS:**
 112
 113 +--------------------------------------+--------------------------------------+
 114 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 115 |                                      |                                      |
 116 +--------------------------------------+--------------------------------------+
 117 |                                      |                                      |
 118 |                                      |                                      |
 119 |                                      |                                      |
 120 +--------------------------------------+--------------------------------------+
 121 |                                      |                                      |
 122 |                                      |                                      |
 123 |                                      |                                      |
 124 +--------------------------------------+--------------------------------------+
 125
 126 Deliverables
 127 ----------------
 128
 129 Software deliverables
 130 ^^^^^^^^^^^^^^^^^^^^^^^
 131
 132 <STATE WHAT SOFTWARE DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
 133
 134 <EXAMPLE>:
 135
 136 Documentation deliverables
 137 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 138
 139 <STATE WHAT DOCUMENTATION DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
 140
 141 <EXAMPLE>:
 142
 143
 144 Known Limitations, Issues and Workarounds
 145 =========================================
 146
 147 System Limitations
 148 ^^^^^^^^^^^^^^^^^^^^
 149 <STATE ALL RELEVANT SYSTEM LIMITATIONS, IF THERE IS ANY>
 150
 151
 152
 153 Known issues
 154 ^^^^^^^^^^^^^^^
 155 <STATE ALL KNOWN ISSUES WITH JIRA REFERENCE>
 156
 157 <EXAMPLE>:
 158
 159 **JIRA TICKETS:**
 160
 161 +--------------------------------------+--------------------------------------+
 162 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 163 |                                      |                                      |
 164 +--------------------------------------+--------------------------------------+
 165 |                                      |                                      |
 166 |                                      |                                      |
 167 |                                      |                                      |
 168 +--------------------------------------+--------------------------------------+
 169 |                                      |                                      |
 170 |                                      |                                      |
 171 |                                      |                                      |
 172 +--------------------------------------+--------------------------------------+
 173
 174 Workarounds
 175 ^^^^^^^^^^^^^^^^^
 176
 177 <STATE ALL KNOWN WORKAROUNDS TO THE ISSUES STATED ABOVE, IF THERE IS ANY>
 178
 179
 180
 181
 182 References
 183 ==========
 184 <STATE RELEVANT REFERENCES FOR THIS RELEASE/VERSION>
 185
 186
 187
 188