Remove Helm Manager and SDNC A1 Controller

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

diff --git a/docs/api-docs.rst b/docs/api-docs.rst
index a296460..db23bca 100644 (file)
--- a/docs/api-docs.rst
+++ b/docs/api-docs.rst
@@ -1,51 +1,34 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
+.. Copyright (C) 2021 Nordix
 
+.. _api_docs:
 
 
+========
 API-Docs
 ========
 
-This is the API-docs of Non-RT RIC.
-
-.. contents::
-   :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`_
-
-.. _gerrit: https://gerrit.nordix.org/c/oransc/nonrtric/+/2747/
-
-- Before compiling, run the following commands::
-
-    git submodule init
+Descriptions of the APIs to the Non-RT RIC functions can be found in the repos for the functions.
 
-    git submodule update
+See Also: Non-RT RIC Control Panel
+==================================
 
-- Start the backend (you might have to build it first)::
+The Non-RT RIC Control Panel provides a user interface that allows the user to interact with the Non-RT RIC.
 
-    mvn clean install
+Documentation for the Control Panel can be found here: `Non-RT RIC Control Panel <https://docs.o-ran-sc.org/projects/o-ran-sc-portal-nonrtric-controlpanel/en/latest/>`_.
 
-    mvn -Dorg.oransc.ric.portal.dashboard=mock -Dtest=DashboardTestServer -DfailIfNoTests=false test
+It can be downloaded from here: ::
 
+  git clone "https://gerrit.o-ran-sc.org/r/portal/nonrtric-controlpanel".
 
-- Now you can open URL:  `localhost:8080`_ in a browser. 
+See Also: A1 / Near-RT RIC simulator
+====================================
 
-.. _localhost:8080: localhost:8080
+The Near-RT RIC simulator simulates an A1 protocol termination endpoint.
 
-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.
+Documentation for the simulator can be found here: `A1 Interface Simulator <https://docs.o-ran-sc.org/projects/o-ran-sc-sim-a1-interface/en/latest/>`_.
 
-When the instances are listed, it is possible to edit or delete each instance from the expanded view.
+It can be downloaded from here: ::
 
-.. image:: ./images/non-RT_RIC_dashboard.png
\ No newline at end of file
+  git clone "https://gerrit.o-ran-sc.org/r/sim/a1-interface"