summaryrefslogtreecommitdiffstats
path: root/docs/development/devtools
diff options
context:
space:
mode:
authorliamfallon <liam.fallon@est.tech>2022-11-01 13:16:21 +0000
committerLiam Fallon <liam.fallon@est.tech>2022-11-01 17:00:48 +0000
commit688a2dd3a681c28ac48ad737316c2dc1dff08526 (patch)
tree2cec8ad6af476f64fdf13f495788a277ee88644b /docs/development/devtools
parentb0f136169fcf812b4f030a6d0ffe2817977b313c (diff)
Fix doc config files and dead links
Documentation config fixed as instructed. Configuration files have been copied from examples provided by the documentation project. Dead links are fixed as well, they cause build fails now. Issue-ID: POLICY-4426 Change-Id: Ied5ca5e5a24f7a625e5b2d94c46d0c2347c68ace Signed-off-by: liamfallon <liam.fallon@est.tech>
Diffstat (limited to 'docs/development/devtools')
-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
3 files changed, 6 insertions, 9 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.