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