summaryrefslogtreecommitdiffstats
path: root/docs/platform
diff options
context:
space:
mode:
Diffstat (limited to 'docs/platform')
-rw-r--r--docs/platform/architecture.rst4
-rw-r--r--docs/platform/index.rst30
-rw-r--r--docs/platform/installation/installation/uui-over-oom.rst6
3 files changed, 20 insertions, 20 deletions
diff --git a/docs/platform/architecture.rst b/docs/platform/architecture.rst
index 10891050..990c4c78 100644
--- a/docs/platform/architecture.rst
+++ b/docs/platform/architecture.rst
@@ -15,6 +15,6 @@ Usecase-UI includes two modules : Usecase-UI Frontend and Usecase-UI Backend.
- Usecase UI UI (Frontend Module)
- Usecase UI Server (Backend Module)
-Usecase-UI mainly consists of two modules, they are the UI module and Server module respectively.
The UI module provides Graphical User Interface (GUI) for operators and end-users (e.g. LCM, Monitor).
-The Server module is the logic part of Usecase-UI. This part provide ONAP other components APIs for Usecase-UI frontend.
+The Server module is the logic part of Usecase-UI. This module provides APIs of ONAP's other components (e.g So,AAI) to Usecase-UI frontend.
+
diff --git a/docs/platform/index.rst b/docs/platform/index.rst
index 59a701b5..29f92493 100644
--- a/docs/platform/index.rst
+++ b/docs/platform/index.rst
@@ -14,29 +14,29 @@ Usecase-UI
Usecase-UI provides self-service management GUI and monitor GUI for operators and end-users.
This project targets identifying all GUI requirements which operators and end-users need ONAP to support,
-coordinating GUI parts of each ONAP subsystem, filling the gaps for improving GUI functionalities for use cases.
+coordinating GUI parts of each ONAP subsystem, filling the gaps for improving GUI functionalities for various use cases.
-* support customer and service type management GUI
-* support E2E instance lifecycle management GUI
-* support NS instance lifecycle management GUI
-* support NS/VNF/PNF package management GUI
-* support network management GUI for OTN Domain
+* support customer and service type management GUI.
+* support E2E instance lifecycle management GUI.
+* support NS instance lifecycle management GUI.
+* support NS/VNF/PNF package management GUI.
+* support network management GUI for OTN Domain.
Usecase UI is composed of two parts that are usecase-ui and usecase-ui-server.
* Usecase UI (Frontend)
- * providing customer and service type management GUI
- * providing E2E instance lifecycle management GUI
- * providing NS instance lifecycle management GUI
- * providing NS/VNF/PNF package management GUI
- * providing network management GUI for OTN Domain
+ * providing customer and service type management GUI.
+ * providing E2E instance lifecycle management GUI.
+ * providing NS instance lifecycle management GUI.
+ * providing NS/VNF/PNF package management GUI.
+ * providing network management GUI for OTN Domain.
* Usecase UI Server (Backend)
- * providing postgreSQL for recording instance operation history
- * providing template analysis result via calling modeling parser
- * providing the way to call ONAP other components APIs
+ * providing postgreSQL for recording instance operation history.
+ * providing template analysis result via calling modeling parser.
+ * providing the way to call ONAP other components APIs.
.. toctree::
@@ -48,4 +48,4 @@ Usecase UI is composed of two parts that are usecase-ui and usecase-ui-server.
delivery.rst
logging.rst
installation/index
- administration.rst \ No newline at end of file
+ administration.rst
diff --git a/docs/platform/installation/installation/uui-over-oom.rst b/docs/platform/installation/installation/uui-over-oom.rst
index dcf6bce5..88235d94 100644
--- a/docs/platform/installation/installation/uui-over-oom.rst
+++ b/docs/platform/installation/installation/uui-over-oom.rst
@@ -42,20 +42,20 @@ https://onap.readthedocs.io/en/latest/submodules/oom.git/docs/oom_quickstart_gui
1. First ensure Usecase-UI is marked true against field enabled in the oom/kubernetes/onap/values.yaml for successful deployment.
2. Upgrade Images in OOM charts to ensure the component version is right, you should check the respective component image version in Usecase-UI charts.
-If you need update the version, please modify values.yaml files.
+If you need to update the version, please modify values.yaml files.
3. Rebuild all repos in helm. Every time you change the charts, you need to rebuild all repos to ensure the change can take effect.
**4. Debug and Testing in running Pod**
=======================================
-When you are doing the testing and would like to replace some new file like binary or some script and want to check the new resut.
+When you are doing the testing and would like to replace some new file like binary or some script and want to check the new result.
Before you replace the file to the running pod,you need to close the pod livenessProbe and readinessProbe first to avoid the pod restart.
**5. Kubectl basic command**
============================
-Basic operation of kubernests cluster(Take the namespace of onap in linux client as an example)
+Basic operation of kubernetes cluster(Take the namespace of onap in linux client as an example)
* Check the cluster node