From 1e7e2efe579d07b32a75081e5020f10bdf406633 Mon Sep 17 00:00:00 2001 From: Donald Hunter Date: Wed, 21 Nov 2018 14:17:28 +0000 Subject: Fix bugs and sphinx-build warnings in docs Change-Id: Ibe6113b1420bbd0c6cf066e38b2cbb045278809e Issue-ID: DCAEGEN2-992 Signed-off-by: Donald Hunter --- docs/sections/apis/DFC.rst | 2 +- docs/sections/installation_oom.rst | 10 +++++----- docs/sections/services/mapper/index.rst | 2 +- docs/sections/services/prh/authorization.rst | 2 ++ docs/sections/services/ves-http/index.rst | 15 ++++++++------- 5 files changed, 17 insertions(+), 14 deletions(-) diff --git a/docs/sections/apis/DFC.rst b/docs/sections/apis/DFC.rst index c8540187..df68064c 100644 --- a/docs/sections/apis/DFC.rst +++ b/docs/sections/apis/DFC.rst @@ -167,7 +167,7 @@ We have two keystore files, one for TrustManager, one for KeyManager. -------------------- update /etc/vsftpd/vsftpd.conf: - .. code-block:: javascript + .. code-block:: bash rsa_cert_file=/etc/ssl/private/ftp.crt rsa_private_key_file=/etc/ssl/private/ftp.key diff --git a/docs/sections/installation_oom.rst b/docs/sections/installation_oom.rst index 9691dce6..2d963d09 100644 --- a/docs/sections/installation_oom.rst +++ b/docs/sections/installation_oom.rst @@ -20,8 +20,8 @@ All ONAP Helm Charts are organized under the **kubernetes** directory of the **O The PNDA data platform is an optional DCAE component that is placed under the **pnda** directory. Details for how to configure values to enable PNDA installation during Helm install -are described in `Installing PNDA During Helm Chart Based DCAE Deployment -`_. +are described in :doc:`Installing PNDA During Helm Chart Based DCAE Deployment +`. DCAE Chart Organization ----------------------- @@ -128,9 +128,9 @@ DCAE Service Endpoints ---------------------- Below is a table of default hostnames and ports for DCAE component service endpoints in Kuubernetes deployment: - ================== ============================ ====================================================== + ================== ================================= ====================================================== Component Cluster Internal (host:port) Cluster external (svc_name:port) - ================== ============================ ====================================================== + ================== ================================= ====================================================== VES dcae-ves-collector:8080 xdcae-ves-collector.onap:30235 HV-VES dcae-hv-ves-collector:6061 xdcae-hv-ves-collector.onap:30222 TCA dcae-tca-analytics:11011 xdcae-tca-analytics.onap:32010 @@ -143,7 +143,7 @@ Below is a table of default hostnames and ports for DCAE component service endpo Config binding config-binding-service:10000 NA DCAE Healthcheck dcae-healthcheck:80 NA Cloudify Manager dcae-cloudify-manager:80 NA - ================== ============================ ====================================================== + ================== ================================= ====================================================== In addition, a number of ONAP service endpoints that are used by DCAE components are listed as follows for reference by DCAE developers and testers: diff --git a/docs/sections/services/mapper/index.rst b/docs/sections/services/mapper/index.rst index 8d5ebed9..b142ded0 100644 --- a/docs/sections/services/mapper/index.rst +++ b/docs/sections/services/mapper/index.rst @@ -21,7 +21,7 @@ There are 2 micro services in the mapper functionality. .. toctree:: - :maxdepth: 1 + :maxdepth: 1 ./flow.rst ./delivery.rst diff --git a/docs/sections/services/prh/authorization.rst b/docs/sections/services/prh/authorization.rst index fe5ed40b..6bf712e1 100644 --- a/docs/sections/services/prh/authorization.rst +++ b/docs/sections/services/prh/authorization.rst @@ -24,6 +24,7 @@ Certificate-based | To achieve this secure flag needs to be turned on in PRH :ref:`configuration` : .. code-block:: json + security.enableAaiCertAuth=true DMaaP BC authentication @@ -41,6 +42,7 @@ Certificate-based | To achieve this secure flag needs to be turned on in PRH :ref:`configuration` : .. code-block:: json + --security.enableDmaapCertAuth=true PRH identity and certificate data diff --git a/docs/sections/services/ves-http/index.rst b/docs/sections/services/ves-http/index.rst index fcdbdc2b..48b91d8c 100644 --- a/docs/sections/services/ves-http/index.rst +++ b/docs/sections/services/ves-http/index.rst @@ -17,14 +17,15 @@ VES Collector (HTTP) overview and functions .. toctree:: - :maxdepth: 1 - ./architecture.rst - ./configuration.rst - ./delivery.rst - ./installation.rst + :maxdepth: 1 + + ./architecture.rst + ./configuration.rst + ./delivery.rst + ./installation.rst + - API reference ^^^^^^^^^^^^^ -Refer to :doc:`VES APIs<../../apis/ves.rst>` for detailed api information. \ No newline at end of file +Refer to :doc:`VES APIs <../../apis/ves>` for detailed api information. -- cgit 1.2.3-korg