Documentation reorganisation

[nonrtric.git] / docs / api-docs.rst

diff --git a/docs/api-docs.rst b/docs/api-docs.rst
index 193a828..a98672a 100644 (file)
--- a/docs/api-docs.rst
+++ b/docs/api-docs.rst
@@ -2,7 +2,7 @@
 .. http://creativecommons.org/licenses/by/4.0
 
 
-
+========
 API-Docs
 ========
 
@@ -12,40 +12,37 @@ This is the API-docs of Non-RT RIC.
    :depth: 3
    :local:
 
-API Introduction
------------------
-
-The Non-RT RIC dashboard is an interface that allows human users to create, edit and delete policy instances, for each existing policy type. The policy types are owned by the Near-RT RIC, Non-RT RIC can just query them, so it's not possible to act on them.
-
-
-API Functions
--------------
-
-To run the dashboard locally, you can follow these steps:
-
-- Fetch the latest code from `gerrit`_
+The Non-RT RIC consists of two parts, described in the sections below:
+ * The Policy Agent
+ * The SDNC A1 Controller
 
-.. _gerrit: https://gerrit.nordix.org/c/oransc/nonrtric/+/2747/
 
-- Before compiling, run the following commands::
+Policy Agent
+============
 
-    git submodule init
+The Policy Agent provides common functionality useful for R-Apps, for instance:
+ * A repository of available Near-RT RICs, their policy types and policy instances.
+ * An A1 connection to the Near-RT RICs.
 
-    git submodule update
+See the README.md file in the nonrtric/policy-agent repo for info about how to use it.
 
-- Start the backend (you might have to build it first)::
-
-    mvn clean install
+API Functions
+-------------
+See the following document for the Policy Agent API: nonrtric/policy-agent/docs/api.yaml
 
-    mvn -Dorg.oransc.ric.portal.dashboard=mock -Dtest=DashboardTestServer -DfailIfNoTests=false test
+SDNC A1 Controller
+==================
 
+An ONAP SDNC Controller for the A1 interface.
 
-- Now you can open URL:  `localhost:8080`_ in a browser.
+See the README.md file in the nonrtric/sdnc-a1-controller repo for info about how to use it.
 
-.. _localhost:8080: localhost:8080
+Complementary tools
+===================
 
-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.
+There are two additional tools that can be used together with the Non-RT RIC, namely the control panel and the Near-RT RIC simulator.
 
-When the instances are listed, it is possible to edit or delete each instance from the expanded view.
+The Non-RT RIC Control panel provides a user interface that allows the user to interact with the Non-RT RIC.
+It can be downloaded using: git clone "https://gerrit.o-ran-sc.org/r/portal/nonrtric-controlpanel"
 
-.. image:: ./images/non-RT_RIC_dashboard.png
\ No newline at end of file
+The Near-RT RIC simulator does what its name suggests, and can be downloaded here: git clone "https://gerrit.o-ran-sc.org/r/sim/a1-interface"