aboutsummaryrefslogtreecommitdiffstats
path: root/docs/development/devtools
diff options
context:
space:
mode:
authorliamfallon <liam.fallon@est.tech>2021-10-11 11:57:31 +0100
committerliamfallon <liam.fallon@est.tech>2021-10-12 13:53:44 +0100
commit40f09542ef0fcbb652a96ac8bd3f691c5a72cc83 (patch)
tree1360a91aa1e1ee5d8866c32e87d55c6ae1de9296 /docs/development/devtools
parent196eb6f1bb30ae7820815e3fa1e574da4e3d1554 (diff)
Fix warnings in PF documentation generation
Geeneration of documents in the Policy Framework issued many warnings, for example missing links, hanging references, unreferenced pages and missing swagger, as well as bad formatting for code blocks. This commit cleans up all the warnings. Issue-ID: POLICY-3337 Change-Id: I20db6ff76cfb58a603317f5faf20c7479b77c13b Signed-off-by: liamfallon <liam.fallon@est.tech>
Diffstat (limited to 'docs/development/devtools')
-rw-r--r--docs/development/devtools/devtools.rst61
1 files changed, 61 insertions, 0 deletions
diff --git a/docs/development/devtools/devtools.rst b/docs/development/devtools/devtools.rst
index fac06ac6..1a001b02 100644
--- a/docs/development/devtools/devtools.rst
+++ b/docs/development/devtools/devtools.rst
@@ -267,6 +267,36 @@ 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 Smoke Tests
+***********************
+
+The following links contain instructions on how to run the smoke tests. These may be helpful to developers to become
+familiar with the Policy Framework components and test any local changes.
+
+.. toctree::
+ :maxdepth: 1
+
+..
+ api-smoke.rst
+
+..
+ pap-smoke.rst
+
+..
+ apex-smoke.rst
+
+..
+ drools-smoke.rst
+
+..
+ xacml-smoke.rst
+
+..
+ distribution-smoke.rst
+
+..
+ clamp-smoke.rst
+
Running the Stability/Performance Tests
***************************************
@@ -283,6 +313,37 @@ familiar with the Policy Framework components and test any local changes.
xacml-s3p.rst
distribution-s3p.rst
+Running the Pairwise Tests
+***********************
+
+The following links contain instructions on how to run the pairwise tests. These may be helpful to developers check that
+the Policy Framework works in a full ONAP deployment.
+
+.. toctree::
+ :maxdepth: 1
+
+..
+ api-pairwise.rst
+
+..
+ pap-pairwise.rst
+
+..
+ apex-pairwise.rst
+
+..
+ drools-pairwise.rst
+
+..
+ xacml-pairwise.rst
+
+..
+ distribution-pairwise.rst
+
+..
+ clamp-pairwise.rst
+
+
Generating Swagger Documentation
********************************
The `Policy Parent Integration POM <https://github.com/onap/policy-parent/blob/master/integration/pom.xml>`_ contains a *generateSwaggerDocs* profile. This