summaryrefslogtreecommitdiffstats
path: root/docs/development
diff options
context:
space:
mode:
authorRamesh Murugan Iyer <ramesh.murugan.iyer@est.tech>2022-11-02 07:26:55 +0000
committerGerrit Code Review <gerrit@onap.org>2022-11-02 07:26:55 +0000
commit782ccb88294a3b43fdd368ae3a98fdd72aca0c24 (patch)
tree791531c264a04554fd3f66a77016286e4f6ac1ca /docs/development
parent0645b537ab50bbda1757c49a626d987ff9b34467 (diff)
parent688a2dd3a681c28ac48ad737316c2dc1dff08526 (diff)
Merge "Fix doc config files and dead links"
Diffstat (limited to 'docs/development')
-rw-r--r--docs/development/devtools/clamp-smoke.rst2
-rw-r--r--docs/development/devtools/devtools.rst9
-rw-r--r--docs/development/devtools/policy-gui-acm-smoke.rst4
-rw-r--r--docs/development/prometheus-metrics.rst2
4 files changed, 7 insertions, 10 deletions
diff --git a/docs/development/devtools/clamp-smoke.rst b/docs/development/devtools/clamp-smoke.rst
index 478ba8eb..3a1efa9b 100644
--- a/docs/development/devtools/clamp-smoke.rst
+++ b/docs/development/devtools/clamp-smoke.rst
@@ -27,7 +27,7 @@ The procedure documented in this article has been verified using Ubuntu 20.04 LT
Cloning CLAMP automation composition and all dependency
*******************************************************
-Run a script such as the script below to clone the required modules from the `ONAP git repository <https://gerrit.onap.org/r/#/admin/projects/?filter=policy>`_. This script clones CLAMP automation composition and all dependency.
+Run a script such as the script below to clone the required modules from the `ONAP git repository <https://gerrit.onap.org/r/admin/repos/q/filter:policy>`_. This script clones CLAMP automation composition and all dependency.
ONAP Policy Framework has dependencies to the ONAP Parent *oparent* module, the ONAP ECOMP SDK *ecompsdkos* module, and the A&AI Schema module.
diff --git a/docs/development/devtools/devtools.rst b/docs/development/devtools/devtools.rst
index ab57cd28..cfd0ab61 100644
--- a/docs/development/devtools/devtools.rst
+++ b/docs/development/devtools/devtools.rst
@@ -27,7 +27,7 @@ The procedure documented in this article has been verified to work on a MacBook
Cloning All The Policy Repositories
***********************************
-Run a script such as the script below to clone the required modules from the `ONAP git repository <https://gerrit.onap.org/r/#/admin/projects/?filter=policy>`_. This script clones all the ONAP Policy Framework repositories.
+Run a script such as the script below to clone the required modules from the `ONAP git repository <https://gerrit.onap.org/r/admin/repos/q/filter:policy>`_. This script clones all the ONAP Policy Framework repositories.
ONAP Policy Framework has dependencies to the ONAP Parent *oparent* module, the ONAP ECOMP SDK *ecompsdkos* module, and the A&AI Schema module.
@@ -246,7 +246,7 @@ Another example on how to run the MariaDb is using the docker compose file used
`Example Compose Script to run MariaDB <https://gerrit.onap.org/r/gitweb?p=integration/csit.git;a=blob;f=scripts/policy/docker-compose-api.yml;h=e32190f1e6cb6d9b64ddf53a2db2c746723a0c6a;hb=refs/heads/master>`_
Running the API component standalone
-+++++++++++++++++++++++++++++++++++++
+++++++++++++++++++++++++++++++++++++
Assuming you have successfully built the codebase using the instructions above. The only requirement for the API component to run is a
running MariaDb database instance. The easiest way to do this is to run the docker image, please see the mariadb documentation for the latest
@@ -266,7 +266,7 @@ An example of running the api using a docker compose script is located in the Po
`Policy CSIT API Docker Compose <https://gerrit.onap.org/r/gitweb?p=integration/csit.git;a=blob;f=scripts/policy/docker-compose-api.yml;h=e32190f1e6cb6d9b64ddf53a2db2c746723a0c6a;hb=refs/heads/master>`_
Running the PAP component standalone
-+++++++++++++++++++++++++++++++++++++
+++++++++++++++++++++++++++++++++++++
Once you have successfully built the PAP codebase, a running MariaDb database and DMaaP instance will also be required to start up the application.
For MariaDb instance, the easiest way is to run the docker image, please see the mariadb documentation for the latest
@@ -456,9 +456,6 @@ of such a test case.
Charset.defaultCharset());
}
-See `this unit test case <https://github.com/onap/policy-clamp/blob/master/runtime/src/test/java/org/onap/policy/clamp/clds/it/HttpsItCase.java>`_
-for the full example.
-
2. Accessing Swagger documentation for springboot based policy applications
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
diff --git a/docs/development/devtools/policy-gui-acm-smoke.rst b/docs/development/devtools/policy-gui-acm-smoke.rst
index 26da79b0..cd600199 100644
--- a/docs/development/devtools/policy-gui-acm-smoke.rst
+++ b/docs/development/devtools/policy-gui-acm-smoke.rst
@@ -3,7 +3,7 @@
.. _clamp-gui-acm-smoke-tests:
CLAMP GUI Smoke Tests
----------------------------
+---------------------
1. Introduction
***************
The CLAMP GUI for Automation Compositions is designed to provide a user the ability to interact
@@ -195,7 +195,7 @@ This will trigger installation of the required packages. The application is conf
npm start
-This uses nodes internal test dev web server to server the GUI. Once started, you can navigate to the server at "https://localhost:3000" and login with "admin/password".
+This uses nodes internal test dev web server to server the GUI. Once started, you can navigate to the server at "localhost:3000" and login with "admin/password".
That completes the development setup of the environment.
diff --git a/docs/development/prometheus-metrics.rst b/docs/development/prometheus-metrics.rst
index 41b497a7..74532311 100644
--- a/docs/development/prometheus-metrics.rst
+++ b/docs/development/prometheus-metrics.rst
@@ -188,6 +188,6 @@ Key metrics for Policy Distribution
===================================================================
Policy Framework uses ServiceMonitor custom resource definition (CRD) to allow Prometheus to monitor the services it exposes. Label selection is used to determine which services are selected to be monitored.
-For label management and troubleshooting refer to the documentation at: `Prometheus operator <https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/troubleshooting.md#overview-of-servicemonitor-tagging-and-related-elements>`__.
+For label management and troubleshooting refer to the documentation at: `Prometheus operator <https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/troubleshooting.md>`__.
`OOM charts <https://github.com/onap/oom/tree/master/kubernetes/policy/components>`__ for policy include ServiceMonitor and properties can be overrided based on the deployment specifics.