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