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