Documentation updates

Issue-ID: NONRTRIC-643
Change-Id: I6a4bcf5ae9e530a583af9f635b84a10bd275aa85
Signed-off-by: JohnKeeney <john.keeney@est.tech>

diff --git a/docs/api-docs.rst b/docs/api-docs.rst
index 0de1b91..8ab5b45 100644 (file)
--- a/docs/api-docs.rst
+++ b/docs/api-docs.rst
@@ -1,6 +1,6 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
-.. Copyright (C) 2020 Nordix
+.. Copyright (C) 2021 Nordix
 
 .. _api_docs:
 

diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst
index e0cb080..9dc4b8b 100644 (file)
--- a/docs/developer-guide.rst
+++ b/docs/developer-guide.rst
@@ -1,13 +1,13 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. SPDX-License-Identifier: CC-BY-4.0
-.. Copyright (C) 2020 Nordix
+.. Copyright (C) 2021 Nordix
 
 Developer Guide
 ===============
 
 This document provides a quickstart for developers of the Non-RT RIC parts.
 
-Additional developer guides are available on the `O-RAN SC NONRTRIC Developer wiki <https://wiki.o-ran-sc.org/display/RICNR/Release+D>`_
+Additional developer guides are available on the `O-RAN SC NONRTRIC Developer wiki <https://wiki.o-ran-sc.org/display/RICNR/Release+E>`_
 
 A1 Policy Management Service & SDNC/A1 Controller & A1 Adapter
 --------------------------------------------------------------

diff --git a/docs/images/nonrtric-architecture-E.png b/docs/images/nonrtric-architecture-E.png
new file mode 100644 (file)
index 0000000..30e3e7c
Binary files /dev/null and b/docs/images/nonrtric-architecture-E.png differ

diff --git a/docs/index.rst b/docs/index.rst
index 2997c40..57a0509 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,6 +1,6 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. SPDX-License-Identifier: CC-BY-4.0
-.. Copyright (C) 2020 Nordix
+.. Copyright (C) 2021 Nordix
 
 Non-RT RIC
 ==========

diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst
index 0404192..31317c0 100644 (file)
--- a/docs/installation-guide.rst
+++ b/docs/installation-guide.rst
@@ -13,7 +13,7 @@ This document describes how to install the Non-RT RIC components, their dependen
 Preface
 -------
 
-See the README file in the "docker-compose" folder for more information.
+See the README file in the "`docker-compose <https://gerrit.o-ran-sc.org/r/gitweb?p=nonrtric.git;a=tree;f=docker-compose>`" folder for more information.
 
 Software Installation and Deployment
 ------------------------------------
@@ -30,6 +30,9 @@ command to start the components:
            -f policy-service/docker-compose.yaml
            -f ics/docker-compose.yaml
 
+The example above is just an example to start some of the components. 
+For more information on running and configuring the functions can be found in the Readme file in the "`docker-compose <https://gerrit.o-ran-sc.org/r/gitweb?p=nonrtric.git;a=tree;f=docker-compose>`" folder, and on the `wiki page <https://wiki.o-ran-sc.org/display/RICNR/Release+E+-+Run>`
+
 Install with Helm
 +++++++++++++++++
 

diff --git a/docs/overview.rst b/docs/overview.rst
index 3577e9c..10a03da 100644 (file)
--- a/docs/overview.rst
+++ b/docs/overview.rst
@@ -1,8 +1,8 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. SPDX-License-Identifier: CC-BY-4.0
-.. Copyright (C) 2020 Nordix
+.. Copyright (C) 2021 Nordix
 
-.. |archpic| image:: ./images/nonrtric-architecture-D.png
+.. |archpic| image:: ./images/nonrtric-architecture-E.png
   :alt: Image: O-RAN SC - NONRTRIC Overall Architecture
 
 Summary
@@ -31,7 +31,7 @@ These are the components that make up the Non-RT-RIC:
 * Near-RT-RIC A1 Simulator
 * DMaap Adaptor
 
-The code base for "D" Release is in the `NONRTRIC <https://gerrit.o-ran-sc.org/r/admin/repos/nonrtric>`_, `NONRTRIC-ControlPanel <https://gerrit.o-ran-sc.org/r/admin/repos/portal/nonrtric-controlpanel>`_, and `Near-RT-RIC A1-Simulator <https://gerrit.o-ran-sc.org/r/admin/repos/sim/a1-interface>`_ , Gerrit source repositories (D Branch).
+The code base for "E" Release is in the `NONRTRIC <https://gerrit.o-ran-sc.org/r/admin/repos/nonrtric>`_, `NONRTRIC-ControlPanel <https://gerrit.o-ran-sc.org/r/admin/repos/portal/nonrtric-controlpanel>`_, and `Near-RT-RIC A1-Simulator <https://gerrit.o-ran-sc.org/r/admin/repos/sim/a1-interface>`_ , Gerrit source repositories (E-Release Branch).
 
 Non-RT-RIC Control Panel / NONRTRIC Dashboard
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -115,17 +115,20 @@ Coordinate/Register A1-EI Types, Producers, Consumers, and Jobs.
 
 
 Implementation:
+
 * Implemented as a Java Spring Boot application
 
 Dmaap Adapter
 ~~~~~~~~~~~~~
 
-Is a generic information producer, which registeres itself as an information producer of information types (in Information Coordination Service).
+Is a generic information producer, which registers itself as an information producer of information types (in Information Coordination Service).
 The information types are defined in a configuration file. 
-Information jobs can retrieve data from DMaap or Kafka topics and push this to data consumers (accessing the ICS API).
+Information jobs can retrieve data from DMaaP or Kafka topics and push this to data consumers (accessing the ICS API).
 
 Implementation:
-* Implemented as a Java Spring Boot application
+
+1. Implementation as a Java Spring Boot application
+2. Implementation as a Go application 
 
 Non-RT-RIC (Spring Cloud) Service Gateway
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index 792a6a2..055ac25 100644 (file)
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -1,6 +1,6 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
-.. Copyright (C) 2020 Nordix
+.. Copyright (C) 2021 Nordix
 
 =============
 Release-Notes
@@ -14,8 +14,8 @@ This document provides the release notes for the release of the different parts
    :local:
 
 
-Version history A1 Policy Agent
-===============================
+Version history A1 Policy Management Service (A1 Policy Agent) 
+==============================================================
 
 +------------+----------+------------------+--------------------+
 | **Date**   | **Ver.** | **Author**       | **Comment**        |
@@ -38,7 +38,10 @@ Version history A1 Policy Agent
 | 2021-06-23 | 2.2.0    | Henrik Andersson | D Release          |
 |            |          |                  |                    |
 +------------+----------+------------------+--------------------+
-
+| 2021-08-10 | 2.2.1    | Henrik Andersson | D Maintenance      |
+|            |          |                  | Release            |
+|            |          |                  |                    |
++------------+----------+------------------+--------------------+
 
 Version history Enrichment Coordinator Service
 ==============================================
@@ -180,3 +183,21 @@ D
 | **Purpose of the delivery** | Improvements                                      |
 |                             | Introduction of initial version of Helm Manager   |
 +-----------------------------+---------------------------------------------------+
+
+D Maintenance
+-------------
++-----------------------------+---------------------------------------------------+
+| **Project**                 | Non-RT RIC                                        |
+|                             |                                                   |
++-----------------------------+---------------------------------------------------+
+| **Repo/commit-ID**          | nonrtric/973ae56894fb29a929fba9e344cae42e7607087b |
+|                             |                                                   |
++-----------------------------+---------------------------------------------------+
+| **Release designation**     | D                                                 |
+|                             |                                                   |
++-----------------------------+---------------------------------------------------+
+| **Release date**            | 2021-08-10                                        |
+|                             |                                                   |
++-----------------------------+---------------------------------------------------+
+| **Purpose of the delivery** | Minor bug fixes                                   |
++-----------------------------+---------------------------------------------------+
\ No newline at end of file

diff --git a/docs/requirements.rst b/docs/requirements.rst
index 7f4d582..9fe6d37 100644 (file)
--- a/docs/requirements.rst
+++ b/docs/requirements.rst
@@ -1,6 +1,6 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. SPDX-License-Identifier: CC-BY-4.0
-.. Copyright (C) 2020 Nordix
+.. Copyright (C) 2021 Nordix
 
 Requirements for the Non-RT RIC project
 =======================================