Merge "Move Enrichment Producer Logic from backend"
[portal/nonrtric-controlpanel.git] / docs / developer-guide.rst
index 2995872..51752b8 100644 (file)
@@ -1,24 +1,25 @@
 .. 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
 ===============
 
-This document provides a quickstart for developers of the Non-RT RIC Controlpanel.
+This document provides a quickstart for developers of the Non-RT RIC Control Panel.
 
-The Non-RT RIC Controlpanel is an interface that allows human users to create, edit and delete policy instances, for
+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.
 
-Start the Controlpanel for development
-======================================
+Start the Control Panel for development
+=======================================
 
-To run the control panel locally for development with simulated services, follow these steps:
+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
+.. _gerrit: https://gerrit.o-ran-sc.org/r/admin/repos/portal/nonrtric-controlpanel
 
 - Start the backend:
 
@@ -26,12 +27,12 @@ To run the control panel locally for development with simulated services, follow
 
     mvn clean install
 
-    mvn -Dorg.oransc.portal.nonrtric.controlpanel=mock -Dtest=ControlpanelTestServer -DfailIfNoTests=false test
+    mvn -Dorg.oransc.portal.nonrtric.controlpanel=mock -Dtest=MockControlPanelBackEnd -DfailIfNoTests=false test
 
 
 - Now you can open URL:  `localhost:8080`_ in a browser to access the backend directly.
 
-.. _localhost:8080: localhost:8080
+.. _localhost:8080: http://localhost:8080
 
 Start the frontend:
 
@@ -39,9 +40,9 @@ Start the frontend:
 
     ./ng serve --proxy-config proxy.conf.json
 
-- Now you can open URL:  `localhost:4200`_ in a browser to access the Controlpanel.
+- 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.