Merge "Update Read the Docs for NonRtRic Control Panel"

[portal/nonrtric-controlpanel.git] / docs / developer-guide.rst

diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst
index 8dc48fb..5804f23 100644 (file)
--- a/docs/developer-guide.rst
+++ b/docs/developer-guide.rst
@@ -1,5 +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
 
 Developer Guide
 ===============
@@ -9,51 +10,63 @@ This document provides a quickstart for developers of the Non-RT RIC Control Pan
 The Non-RT RIC Control Panel 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.
+Additionally, producers and jobs for the Enrichment Information coordinator service can be viewed and managed.
+
+See the README.md file in the nonrtric-controlpanel repo for information about how to use it.
 
 Start the Control Panel 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:
+.. _gerrit: https://gerrit.o-ran-sc.org/r/admin/repos/portal/nonrtric-controlpanel
 
-    cd webapp-backend
+- Start the frontend:
 
-    mvn clean install
+    +------------------------------+
+    | cd webapp-frontend           |
+    +------------------------------+
 
-    mvn -Dorg.oransc.portal.nonrtric.controlpanel=mock -Dtest=ControlPanelTestServer -DfailIfNoTests=false test
+    - To start the frontend with Mock data:
 
+        +------------------------------+
+        | npm run start:mock           |
+        +------------------------------+
 
-- Now you can open URL:  `localhost:8080`_ in a browser to access the backend directly.
+    - To start the UI:
 
-.. _localhost:8080: localhost:8080
+        - You need to start the ControlPanel API Gateway, Policy Management Service & EI Service for the UI to list policy & EI information
 
-Start the frontend:
+        +---------------------------------------------------+
+        | ./ng serve --proxy-config proxy.conf.json         |
+        +---------------------------------------------------+
 
-    cd webapp-frontend
+        OR
 
-    ./ng serve --proxy-config proxy.conf.json
+        +---------------------+
+        | npm start           |
+        +---------------------+
 
-- Now you can open URL:  `localhost:4200`_ in a browser to access the Control Panel.
+    - Now you can open URL:  `localhost:4200`_ in a browser to access the Control Panel.
 
-.. _localhost:4200: localhost:4200
+    .. _localhost:4200: http://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
+.. image:: ./images/non-RT_RIC_controlpanel_Policy.PNG
 
+In order to view producers and jobs from the EI service, from the main page, click on the "Enrichment information coordinator" card or use the menu on the left hand side of the page. 
+
+.. image:: ./images/non-RT_RIC_controlpanel_EI.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
+.. _guide: https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=34963461
\ No newline at end of file