Merge "SMO-36: Update documentation for smo/o1 using the files in docs folder"
[smo/o1.git] / 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 releases related to SMO O1.
10
11 .. contents::
12    :depth: 3
13    :local:
14
15
16 Version history
17 ---------------
18
19 +--------------------+--------------------+--------------------+--------------------+
20 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
21 |                    |                    |                    |                    |
22 +--------------------+--------------------+--------------------+--------------------+
23 | 2021-12-15         | E                  |                    | E-release          |
24 |                    |                    |                    |                    |
25 +--------------------+--------------------+--------------------+--------------------+
26 | 2021-06-15         | D                  |                    | Dawn release       |
27 |                    |                    |                    |                    |
28 +--------------------+--------------------+--------------------+--------------------+
29 | 2020-12-15         | C                  |                    | Cherry release     |
30 |                    |                    |                    |                    |
31 +--------------------+--------------------+--------------------+--------------------+
32
33
34 Summary
35 -------
36
37 E-release:
38
39 The E-release was targeted towards network slicing. The O1 interface did not need any updates to support the use case. Most of the support for the use case has to come in the Network Function (NF), and in the rApp that supports the use case. The only percievable change is the change in the logo to the GUI interface.
40
41 The D(awn) release was targeted towards implementation of the O1 interface itself and getting an initial implementation in place.
42
43
44 Release Data
45 ------------
46
47 +--------------------------------------+--------------------------------------+
48 | **Project**                          | E.g. project                         |
49 |                                      |                                      |
50 +--------------------------------------+--------------------------------------+
51 | **Repo/commit-ID**                   | Repo: smo/o1                         |
52 |                                      | Commit id:                           |
53 +--------------------------------------+--------------------------------------+
54 | **Release designation**              |                                      |
55 |                                      |                                      |
56 +--------------------------------------+--------------------------------------+
57 | **Release date**                     | 2021-12-15                           |
58 |                                      |                                      |
59 +--------------------------------------+--------------------------------------+
60 | **Purpose of the delivery**          | Support network slicing              |
61 |                                      |                                      |
62 +--------------------------------------+--------------------------------------+
63
64
65
66
67 Feature Additions
68 ^^^^^^^^^^^^^^^^^
69
70 **JIRA BACK-LOG:**
71
72 +--------------------------------------+--------------------------------------+
73 | **JIRA REFERENCE**                   | **SLOGAN**                           |
74 |                                      |                                      |
75 +--------------------------------------+--------------------------------------+
76 |                                      |                                      |
77 |                                      |                                      |
78 |                                      |                                      |
79 +--------------------------------------+--------------------------------------+
80 |                                      |                                      |
81 |                                      |                                      |
82 |                                      |                                      |
83 +--------------------------------------+--------------------------------------+
84
85 Bug Corrections
86 ^^^^^^^^^^^^^^^
87
88 **JIRA TICKETS:**
89
90 +--------------------------------------+--------------------------------------+
91 | **JIRA REFERENCE**                   | **SLOGAN**                           |
92 |                                      |                                      |
93 +--------------------------------------+--------------------------------------+
94 | SMO-11                               | Change banner in O1 GUI interface    |
95 |                                      |                                      |
96 |                                      |                                      |
97 +--------------------------------------+--------------------------------------+
98 |                                      |                                      |
99 |                                      |                                      |
100 |                                      |                                      |
101 +--------------------------------------+--------------------------------------+
102
103 Deliverables
104 ^^^^^^^^^^^^
105
106 Software Deliverables
107 +++++++++++++++++++++
108
109 <STATE WHAT SOFTWARE DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
110
111
112
113 Documentation Deliverables
114 ++++++++++++++++++++++++++
115
116 <STATE WHAT DOCUMENTATION DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
117
118
119
120
121 Known Limitations, Issues and Workarounds
122 -----------------------------------------
123
124 System Limitations
125 ^^^^^^^^^^^^^^^^^^
126 <STATE ALL RELEVANT SYSTEM LIMITATIONS, IF THERE IS ANY>
127
128
129
130 Known Issues
131 ^^^^^^^^^^^^
132 <STATE ALL KNOWN ISSUES WITH JIRA REFERENCE>
133
134 <EXAMPLE>:
135
136 **JIRA TICKETS:**
137
138 +--------------------------------------+--------------------------------------+
139 | **JIRA REFERENCE**                   | **SLOGAN**                           |
140 |                                      |                                      |
141 +--------------------------------------+--------------------------------------+
142 |                                      |                                      |
143 |                                      |                                      |
144 |                                      |                                      |
145 +--------------------------------------+--------------------------------------+
146 |                                      |                                      |
147 |                                      |                                      |
148 |                                      |                                      |
149 +--------------------------------------+--------------------------------------+
150
151 Workarounds
152 ^^^^^^^^^^^
153
154 <STATE ALL KNOWN WORKAROUNDS TO THE ISSUES STATED ABOVE, IF THERE IS ANY>
155
156
157
158
159 References
160 ----------
161 <STATE RELEVANT REFERENCES FOR THIS RELEASE/VERSION>
162
163
164
165