diff options
| author |   liamfallon <liam.fallon@est.tech> | 2021-10-11 11:57:31 +0100 |
|---|---|---|
| committer | liamfallon <liam.fallon@est.tech> | 2021-10-12 13:53:44 +0100 |
| commit | 40f09542ef0fcbb652a96ac8bd3f691c5a72cc83 (patch) | |
| tree | 1360a91aa1e1ee5d8866c32e87d55c6ae1de9296 /docs/development/actors | |
| parent | 196eb6f1bb30ae7820815e3fa1e574da4e3d1554 (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/actors')
| -rw-r--r-- | docs/development/actors/cds/cds.rst | 2 | ||||
| -rw-r--r-- | docs/development/actors/vfc/vfc.rst | 8 |
2 files changed, 5 insertions, 5 deletions
diff --git a/docs/development/actors/cds/cds.rst b/docs/development/actors/cds/cds.rst index d991f6c5..efc6c4cc 100644 --- a/docs/development/actors/cds/cds.rst +++ b/docs/development/actors/cds/cds.rst @@ -337,7 +337,7 @@ E.g. For vFW usecase the policy-type is "onap.policies.controlloop.operational.c In the below rest endpoint, the hostname points to K8S service "policy-api" and internal port 6969. -.. code-block:: bash +.. code-block:: curl POST 'https://{$POLICY_API_URL}:{$POLICY_API_SERVICE_PORT}/policy/api/v1/policytypes/onap.policies.controlloop.operational.common.Drools/versions/1.0.0/policies/operational.modifyconfig/versions/1.0.0' \ -H 'Accept: application/json' \ diff --git a/docs/development/actors/vfc/vfc.rst b/docs/development/actors/vfc/vfc.rst index e7d8d3e7..c4f3d077 100644 --- a/docs/development/actors/vfc/vfc.rst +++ b/docs/development/actors/vfc/vfc.rst @@ -16,10 +16,10 @@ Overview of VFC Actor ONAP Policy Framework enables VFC as one of the supported actors. .. note:: -There has not been any support given to the Policy Framework project for the VFC Actor -in several releases. Thus, the code and information provided is to the best of the -knowledge of the team. If there are any questions or problems, please consult the VFC -Project to help provide guidance. + There has not been any support given to the Policy Framework project for the VFC Actor + in several releases. Thus, the code and information provided is to the best of the + knowledge of the team. If there are any questions or problems, please consult the VFC + Project to help provide guidance. VFC uses a REST-based interface. However, as requests may not complete right away, a REST-based polling |