docs/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 ..
   4 .. Copyright (C) 2019 AT&T Intellectual Property
   5
   6
   7 Release-Notes
   8 =============
   9
  10
  11 This document provides the release notes for <RELEASE> of <COMPONENT>.
  12
  13 .. contents::
  14    :depth: 3
  15    :local:
  16
  17
  18 Version history
  19 ---------------
  20
  21 +--------------------+--------------------+--------------------+--------------------+
  22 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
  23 |                    |                    |                    |                    |
  24 +--------------------+--------------------+--------------------+--------------------+
  25 | 20XX-XX-XX         | 0.1.0              |                    | First draft        |
  26 |                    |                    |                    |                    |
  27 +--------------------+--------------------+--------------------+--------------------+
  28 |                    | 0.1.1              |                    |                    |
  29 |                    |                    |                    |                    |
  30 +--------------------+--------------------+--------------------+--------------------+
  31 |                    | 1.0                |                    |                    |
  32 |                    |                    |                    |                    |
  33 +--------------------+--------------------+--------------------+--------------------+
  34
  35
  36 Summary
  37 -------
  38
  39 <SUMMARIZE THE RELEASE - THE CONTENT - AND OTHER IMPORTANT HIGH LEVEL PROPERTIES>
  40
  41
  42
  43
  44 Release Data
  45 ------------
  46 <STATE RELEVANT RELEASE DATA/RECORDS>
  47
  48 <EXAMPLE>:
  49
  50 +--------------------------------------+--------------------------------------+
  51 | **Project**                          | E.g. project                         |
  52 |                                      |                                      |
  53 +--------------------------------------+--------------------------------------+
  54 | **Repo/commit-ID**                   | E.g. genesis/adf634a0d4.....         |
  55 |                                      |                                      |
  56 +--------------------------------------+--------------------------------------+
  57 | **Release designation**              | E.g. Arno RC2                        |
  58 |                                      |                                      |
  59 +--------------------------------------+--------------------------------------+
  60 | **Release date**                     | E.g. 2015-04-16                      |
  61 |                                      |                                      |
  62 +--------------------------------------+--------------------------------------+
  63 | **Purpose of the delivery**          |                                      |
  64 |                                      |                                      |
  65 +--------------------------------------+--------------------------------------+
  66
  67
  68
  69
  70 Feature Additions
  71 ^^^^^^^^^^^^^^^^^
  72 <STATE ADDED FEATURES BY REFERENCE TO JIRA>
  73
  74 <EXAMPLE>:
  75
  76 **JIRA BACK-LOG:**
  77
  78 +--------------------------------------+--------------------------------------+
  79 | **JIRA REFERENCE**                   | **SLOGAN**                           |
  80 |                                      |                                      |
  81 +--------------------------------------+--------------------------------------+
  82 |                                      |                                      |
  83 |                                      |                                      |
  84 |                                      |                                      |
  85 +--------------------------------------+--------------------------------------+
  86 |                                      |                                      |
  87 |                                      |                                      |
  88 |                                      |                                      |
  89 +--------------------------------------+--------------------------------------+
  90
  91 Bug Corrections
  92 ^^^^^^^^^^^^^^^
  93
  94 **JIRA TICKETS:**
  95
  96 +--------------------------------------+--------------------------------------+
  97 | **JIRA REFERENCE**                   | **SLOGAN**                           |
  98 |                                      |                                      |
  99 +--------------------------------------+--------------------------------------+
 100 |                                      |                                      |
 101 |                                      |                                      |
 102 |                                      |                                      |
 103 +--------------------------------------+--------------------------------------+
 104 |                                      |                                      |
 105 |                                      |                                      |
 106 |                                      |                                      |
 107 +--------------------------------------+--------------------------------------+
 108
 109 Deliverables
 110 ^^^^^^^^^^^^
 111
 112 Software Deliverables
 113 +++++++++++++++++++++
 114
 115 <STATE WHAT SOFTWARE DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
 116
 117
 118
 119 Documentation Deliverables
 120 ++++++++++++++++++++++++++
 121
 122 <STATE WHAT DOCUMENTATION DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
 123
 124
 125
 126
 127 Known Limitations, Issues and Workarounds
 128 -----------------------------------------
 129
 130 System Limitations
 131 ^^^^^^^^^^^^^^^^^^
 132 <STATE ALL RELEVANT SYSTEM LIMITATIONS, IF THERE IS ANY>
 133
 134
 135
 136 Known Issues
 137 ^^^^^^^^^^^^
 138 <STATE ALL KNOWN ISSUES WITH JIRA REFERENCE>
 139
 140 <EXAMPLE>:
 141
 142 **JIRA TICKETS:**
 143
 144 +--------------------------------------+--------------------------------------+
 145 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 146 |                                      |                                      |
 147 +--------------------------------------+--------------------------------------+
 148 |                                      |                                      |
 149 |                                      |                                      |
 150 |                                      |                                      |
 151 +--------------------------------------+--------------------------------------+
 152 |                                      |                                      |
 153 |                                      |                                      |
 154 |                                      |                                      |
 155 +--------------------------------------+--------------------------------------+
 156
 157 Workarounds
 158 ^^^^^^^^^^^
 159
 160 <STATE ALL KNOWN WORKAROUNDS TO THE ISSUES STATED ABOVE, IF THERE IS ANY>
 161
 162
 163
 164
 165 References
 166 ----------
 167 <STATE RELEVANT REFERENCES FOR THIS RELEASE/VERSION>
 168
 169
 170
 171