Add initial version of documentation

Change-Id: I955cf17f885564d25c3f13fe3210a20f7ca6e6f7
Issue-ID: NONRTRIC-166
Signed-off-by: elinuxhenrik <henrik.b.andersson@est.tech>

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
new file mode 100644 (file)
index 0000000..095222a
--- /dev/null
+++ b/.readthedocs.yaml
@@ -0,0 +1,16 @@
+---
+version: 2
+
+formats:
+  - htmlzip
+
+build:
+  image: latest
+
+python:
+  version: 3.7
+  install:
+    - requirements: docs/requirements-docs.txt
+
+sphinx:
+  configuration: docs/conf.py

diff --git a/docs/_static/logo.png b/docs/_static/logo.png
new file mode 100644 (file)
index 0000000..c3b6ce5
Binary files /dev/null and b/docs/_static/logo.png differ

diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644 (file)
index 0000000..922e22f
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,6 @@
+from docs_conf.conf import *
+linkcheck_ignore = [
+    'http://localhost.*',
+    'http://127.0.0.1.*',
+    'https://gerrit.o-ran-sc.org.*'
+]

diff --git a/docs/conf.yaml b/docs/conf.yaml
new file mode 100644 (file)
index 0000000..65385b0
--- /dev/null
+++ b/docs/conf.yaml
@@ -0,0 +1,3 @@
+---
+project_cfg: oran
+project: nonrtric-controlpanel

diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst
new file mode 100644 (file)
index 0000000..2995872
--- /dev/null
+++ b/docs/developer-guide.rst
@@ -0,0 +1,59 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+
+Developer Guide
+===============
+
+This document provides a quickstart for developers of the Non-RT RIC Controlpanel.
+
+The Non-RT RIC Controlpanel is an interface that allows human users to create, edit and delete policy instances, for
+each existing policy type. The policy types and their definitions are retrieved from each Near-RT RIC.
+
+See the README.md file in the nonrtric-controlpanel repo for info about how to use it.
+
+Start the Controlpanel for development
+======================================
+
+To run the control panel locally for development with simulated services, follow these steps:
+
+- Fetch the latest code from `gerrit`_
+
+.. _gerrit: https://gerrit.o-ran-sc.org/r/admin/repos/nonrtric-controlpanel
+
+- Start the backend:
+
+    cd webapp-backend
+
+    mvn clean install
+
+    mvn -Dorg.oransc.portal.nonrtric.controlpanel=mock -Dtest=ControlpanelTestServer -DfailIfNoTests=false test
+
+
+- Now you can open URL:  `localhost:8080`_ in a browser to access the backend directly.
+
+.. _localhost:8080: localhost:8080
+
+Start the frontend:
+
+    cd webapp-frontend
+
+    ./ng serve --proxy-config proxy.conf.json
+
+- Now you can open URL:  `localhost:4200`_ in a browser to access the Controlpanel.
+
+.. _localhost:4200: localhost:4200
+
+From the main page, click on the "Policy Control" card. From here, it is possible to create or list instances for each
+existing policy type.
+
+When the instances are listed, it is possible to edit or delete each instance from the expanded view.
+
+.. image:: ./images/non-RT_RIC_controlpanel.png
+
+
+End-to-end call
+===============
+
+In order to make a complete end-to-end call, follow the instructions given in this `guide`_.
+
+.. _guide: https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=12157166
\ No newline at end of file

diff --git a/docs/favicon.ico b/docs/favicon.ico
new file mode 100644 (file)
index 0000000..00b0fd0
Binary files /dev/null and b/docs/favicon.ico differ

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

diff --git a/docs/images/non-RT_RIC_controlpanel.png b/docs/images/non-RT_RIC_controlpanel.png
new file mode 100644 (file)
index 0000000..32f07bf
Binary files /dev/null and b/docs/images/non-RT_RIC_controlpanel.png differ

diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644 (file)
index 0000000..e59e017
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,22 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+
+
+Non-RT RIC Controlpanel
+=======================
+
+.. Add or remove sections below as appropriate for the platform component.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   ./developer-guide.rst
+   ./installation-guide.rst
+   ./overview.rst
+   ./release-notes.rst
+
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst
new file mode 100644 (file)
index 0000000..d7df04e
--- /dev/null
+++ b/docs/installation-guide.rst
@@ -0,0 +1,38 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+
+
+Installation Guide
+==================
+
+.. contents::
+   :depth: 3
+   :local:
+
+Abstract
+--------
+
+This document describes how to install the Non-RT RIC Controlpanel, its dependencies and required system resources.
+
+This work is in progress. For now, it is possible to use the Non-RT RIC Controlpanel.
+
+Version history
+
++--------------------+--------------------+--------------------+--------------------+
+| **Date**           | **Ver.**           | **Author**         | **Comment**        |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+| 2020-03-27         | 0.1.0              | Henrik Andersson   | First draft        |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+|                    | 0.1.1              |                    |                    |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+|                    | 1.0                |                    |                    |
+|                    |                    |                    |                    |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+
+
+

diff --git a/docs/overview.rst b/docs/overview.rst
new file mode 100644 (file)
index 0000000..e2040ac
--- /dev/null
+++ b/docs/overview.rst
@@ -0,0 +1,24 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+
+
+Controlpanel Overview
+=====================
+
+The Non-RT RIC Controlpanel is a graphical user  user interface that enables the user to manage the Policies in the
+network. The Controlpanel interacts with the Policy agent via a REST API.
+The Controlpanel generates its GUI from JSON schemas in a model driven fashion.
+
+The Controlpanel consists of a back end implemented as a Java Spring Boot application and a fronted developed using the
+Angular framework.
+
+Controlpanel architecture
+-------------------------
+
+The architecture of the Controlpanel is as shown on the following picture:
+
+.. image:: ./images/architecture.png
+   :scale: 50 %
+
+The Controlpanel itself is split into the backend and the frontend, and can be deployed following the instructions in
+the README.md file in the repo.
\ No newline at end of file

diff --git a/docs/release-notes.rst b/docs/release-notes.rst
new file mode 100644 (file)
index 0000000..71696a9
--- /dev/null
+++ b/docs/release-notes.rst
@@ -0,0 +1,54 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+=============
+Release-Notes
+=============
+
+
+This document provides the release notes for the release of the Non-RT RIC Controlpanel.
+
+.. contents::
+   :depth: 3
+   :local:
+
+
+Version history
+===============
+
++--------------------+--------------------+--------------------+--------------------+
+| **Date**           | **Ver.**           | **Author**         | **Comment**        |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+| 2020-03-27         | 0.1.0              | Henrik Andersson   | First draft        |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+|                    | 0.1.1              |                    |                    |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+|                    | 1.0                |                    |                    |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+
+
+Release Data
+============
+
+Bronze
+------
++--------------------------------------+--------------------------------------------------+
+| **Project**                          | Non-RT RIC Controlpanel                          |
+|                                      |                                                  |
++--------------------------------------+--------------------------------------------------+
+| **Repo/commit-ID**                   |                                                  |
+|                                      |                                                  |
++--------------------------------------+--------------------------------------------------+
+| **Release designation**              | Bronze                                           |
+|                                      |                                                  |
++--------------------------------------+--------------------------------------------------+
+| **Release date**                     |                                                  |
+|                                      |                                                  |
++--------------------------------------+--------------------------------------------------+
+| **Purpose of the delivery**          | Introducing Non-RT RIC Controlpanel              |
+|                                      |                                                  |
++--------------------------------------+--------------------------------------------------+

diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt
new file mode 100644 (file)
index 0000000..09a0c1c
--- /dev/null
+++ b/docs/requirements-docs.txt
@@ -0,0 +1,5 @@
+sphinx
+sphinx-rtd-theme
+sphinxcontrib-httpdomain
+recommonmark
+lfdocs-conf