Improve documentation

Issue-ID: SIM-62
Change-Id: If79e031d89856d3352ccd69aa637e6b526293820
Signed-off-by: Alex Stancu <alexandru.stancu@highstreet-technologies.com>

diff --git a/docs/overview.rst b/docs/overview.rst
index d478ca5..4bc8ad7 100644 (file)
--- a/docs/overview.rst
+++ b/docs/overview.rst
@@ -429,15 +429,16 @@ Fault generation is controlled using a combination of JSON and YANG settings. Fr
         ]
     }
 
-    * **fault-rules** node should be a main node in *config.json* for the respective network function in order for the fault generation to be enabled
-    * **yang-notif-template** - template of the yang notification model in current network function. can be "" to disable notifications. must always be present
-    * **choosing-method** - method to choose the fault. can be either *linear* or *random*, and must always be present
-    * **faults** list of faults to choose from by "choosing-method". it can contain any number of fields, custom ones, along with the mandatory VES fields presented below:
-        * **condition**
-        * **object**
-        * **severity** - should correspond to VES defined: NORMAL, WARNING, MINOR, MAJOR, CRITICAL (case sensitive)
-        * **date-time**
-        * **specific-problem**
+- **fault-rules** node should be a main node in *config.json* for the respective network function in order for the fault generation to be enabled
+- **yang-notif-template** - template of the yang notification model in current network function. can be "" to disable notifications. must always be present
+- **choosing-method** - method to choose the fault. can be either *linear* or *random*, and must always be present
+- **faults** list of faults to choose from by "choosing-method". it can contain any number of fields, custom ones, along with the mandatory VES fields presented below:
+
+    - **condition**
+    - **object**
+    - **severity** - should correspond to VES defined: NORMAL, WARNING, MINOR, MAJOR, CRITICAL (case sensitive)
+    - **date-time**
+    - **specific-problem**
 
 On the **yang-notif-template** and on any of the fields, there are two options for creating "dynamic" content (also see example above):
 - **variables** - any field put in between %% will be replaced with the field's value

diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index 1cb199c..b6cb4d3 100644 (file)
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -21,6 +21,9 @@ Version history
 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
+| 2021-04-15         | 1.2.1              |  Alex Stancu       | "D" release        |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
 | 2021-04-12         | 1.2.0              |  Alex Stancu       | "D" release        |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
@@ -46,6 +49,12 @@ The O1 interface simulator is a framework that provides simulated network functi
 
 Release Data
 ------------
+
+version 1.2.1
+
+- [fix] VES commmon header made uniform across all VES-related messages
+
+
 version 1.2.0
 
 - [change] **Default password of the NETCONF Server was changed to "netconf!", to be complant with O-RAN requirements**
@@ -60,8 +69,6 @@ version 1.2.0
 
 - [fix] Correctly construct URL for SDN Controller and VES Collector when they are addressed via IPv6
 
-- [fix] VES commmon header made uniform across all VES-related messages
-
 
 version 1.0.3