Release dashboard image at version 2.1.0

[portal/ric-dashboard.git] / docs / overview.rst

diff --git a/docs/overview.rst b/docs/overview.rst
index 2102905..d95f7c3 100644 (file)
--- a/docs/overview.rst
+++ b/docs/overview.rst
@@ -1,25 +1,57 @@
-.. ===============LICENSE_START=======================================================
-.. O-RAN SC CC-BY-4.0
-.. %%
-.. Copyright (C) 2019 AT&T Intellectual Property and Nokia
-.. %%
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-..      http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-.. ===============LICENSE_END=========================================================
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. Copyright (C) 2019 AT&T Intellectual Property
 
-======================
 RIC Dashboard Overview
 ======================
 
-The O-RAN SC RIC Dashboard provides administrative and operator functions.
-The web app is built as a single-page app using an Angular front end and a
-Java Spring-Boot back end.
+The O-RAN SC RIC Dashboard provides administrative and operator
+functions for a radio access network (RAN) controller.  The web app is
+built as a single-page app using an Angular (version 8) front end and
+a Java (version 11) Spring-Boot (version 2.1) back end.
+
+Project Resources
+-----------------
+
+The project uses the following Linux Foundation resources.
+
+* The source code is maintained in this Gerrit:
+    `<https://gerrit.o-ran-sc.org/r/admin/repos/portal/ric-dashboard>`_
+* The build (CI) jobs are in this Jenkins:
+    `<https://jenkins.o-ran-sc.org/view/portal-ric-dashboard>`_
+* Issues are tracked in this Jira:
+    `<https://jira.o-ran-sc.org/issues/?jql=project%3DOAM%20AND%20component%3D%22portal%2Fric-dashboard%22>`_
+* Project information is available in this Wiki:
+    `<https://wiki.o-ran-sc.org/display/OAM/RIC+Dashboard+Application>`_
+
+
+Managed Resources
+-----------------
+
+The RIC Dashboard is used to manage the following RIC Platform and RIC
+xApplication components.
+
+Application Manager
+~~~~~~~~~~~~~~~~~~~
+
+The Dashboard interfaces with the Application Manager.  This platform
+component is accessed via HTTP/REST requests using a client that is
+generated from an API specification published by the Application
+Manager team.
+
+The Application Manager supports deploying, undeploying and
+configuring applications in the RIC. The Dashboard UI provides screens
+for these functions.
+
+
+E2 Manager
+~~~~~~~~~~
+
+The Dashboard interfaces with the E2 Manager.  This platform
+component is accessed via HTTP/REST requests using a client that is
+generated from an API specification published by the E2 Manager team.
+
+The E2 Manager platform component supports connecting and
+disconnecting RAN elements.  The Dashboard UI provides controls for
+operators to create "ENDC" and "X2" connections, and to disconnect RAN
+elements.