clean up some sphinx warnings

Change-Id: I8c2d925e8b27b4740227af0be3ab5d6f7153ec38
Signed-off-by: Hansen, Tony (th1395) <th1395@att.com>
Issue-ID: DCAEGEN2-3399
Signed-off-by: Hansen, Tony (th1395) <th1395@att.com>
Signed-off-by: Vijay Venkatesh Kumar <vv770d@att.com>
Signed-off-by: Hansen, Tony (th1395) <th1395@att.com>

6 files changed, 27 insertions, 29 deletions

diff --git a/docs/sections/services/ves-http/architecture.rst b/docs/sections/services/ves-http/architecture.rst
index 2e7a0039..56c31456 100644
--- a/docs/sections/services/ves-http/architecture.rst
+++ b/docs/sections/services/ves-http/architecture.rst
@@ -11,9 +11,9 @@ VES Processing Flow
 -------------------
 
 1. Collector supports different URI based on single or batch event to be received.
-2. Post authentication – events are validated against schema. At this point – appropriate return code is sent to client when validation fails.
+2. Post authentication - events are validated against schema. At this point - appropriate return code is sent to client when validation fails.
 3. Event Processor checks against transformation rules (if enabled) and handles VES output standardization (e.g. VES 7.x input to VES5.4 output).
-4. Optional (activated by flag *collector.externalSchema.checkflag*) post authentication of stndDefined fields – specific fields are validated against schema. At this point – appropriate return code is sent to client when validation fails.
+4. Optional (activated by flag *collector.externalSchema.checkflag*) post authentication of stndDefined fields - specific fields are validated against schema. At this point - appropriate return code is sent to client when validation fails.
 5. If no problems were detected during previous steps, success HTTP code is being returned.
 6. Based on domain (or stndDefinedNamespace), events are asynchronously distributed to configurable topics.
     1. If topic mapping does not exist, event distribution is skipped.
@@ -51,17 +51,17 @@ Features Supported
 - General schema validation (against standard VES definition)
 - StndDefined fields schema validation
 - Mapping of external schemas to local schema files during stndDefined validation
-- Multiple schema support and backward compatibility 
+- Multiple schema support and backward compatibility
 - Configurable event transformation
-- Configurable suppression 
+- Configurable suppression
 - Publish events into Dmaap Topic (with/without AAF)
 
-The collector can receive events via standard HTTP port (8080) or secure port (8443).  Depending on the install/configuration – either one or both can be supported (ports are also modifiable).
+The collector can receive events via standard HTTP port (8080) or secure port (8443).  Depending on the install/configuration - either one or both can be supported (ports are also modifiable).
 
 Dynamic configuration fed into Collector via DCAEPlatform
 ---------------------------------------------------------
 
-- Outbound Dmaap/UEB topic 
+- Outbound Dmaap/UEB topic
 - Schema version to be validated against
 - Authentication account for VNF
 
@@ -70,5 +70,3 @@ POST requests result in standard HTTP status codes:
 - 200-299  Success
 - 400-499  Client request has a problem (data error)
 - 500-599  Collector service has a problem
- 
-
diff --git a/docs/sections/services/ves-http/configuration.rst b/docs/sections/services/ves-http/configuration.rst
index 6f98b29e..2100108d 100644
--- a/docs/sections/services/ves-http/configuration.rst
+++ b/docs/sections/services/ves-http/configuration.rst
@@ -7,6 +7,7 @@ Configuration
 VES expects to be able to fetch configuration directly from consul service in following JSON format:
 
 .. code-block:: json
+
     {
       "collector.dynamic.config.update.frequency": "5",
       "event.transform.flag": "0",
diff --git a/docs/sections/services/ves-http/delivery.rst b/docs/sections/services/ves-http/delivery.rst
index 0e5e826a..0c90d34a 100644
--- a/docs/sections/services/ves-http/delivery.rst
+++ b/docs/sections/services/ves-http/delivery.rst
@@ -6,4 +6,4 @@ Delivery
 
 **VES** is delivered as a docker container and published in ONAP Nexus repository following image naming convention.
 
-Full image name is `onap/org.onap.dcaegen2.collectors.ves.vescollector`.
\ No newline at end of file
+Full image name is `onap/org.onap.dcaegen2.collectors.ves.vescollector`.
diff --git a/docs/sections/services/ves-http/installation-helm.rst b/docs/sections/services/ves-http/installation-helm.rst
index d5f6bdd6..f251f61d 100644
--- a/docs/sections/services/ves-http/installation-helm.rst
+++ b/docs/sections/services/ves-http/installation-helm.rst
@@ -26,7 +26,7 @@ For example:
         helm -n onap upgrade dev-dcaegen2-services --reuse-values --values new-config.yaml oom/kubernetes/dcaegen2-services

 

 Where the contents of ``new-config.yaml`` file is:

-    .. code-block:: bash

+    .. code-block:: yaml

 

         dcae-ves-collector:

           applicationConfig:

@@ -39,11 +39,13 @@ For small changes like this, it is also possible to inline the new value:
 

 After the upgrade, the new auth method value should be visible inside dev-dcae-ves-collector-application-config-configmap Config-Map.

 It can be verified by running:

+

     .. code-block:: bash

 

         kubectl -n onap get cm <config map name> -o yaml

 

 For VES Collector:

+

     .. code-block:: bash

 

         kubectl -n onap get cm dev-dcae-ves-collector-application-config-configmap -o yaml

@@ -55,9 +57,9 @@ External repository schema files integration with VES Collector
 ---------------------------------------------------------------

 In order to utilize the externalRepo openAPI schema files defined in `OOM <https://gerrit.onap.org/r/gitweb?p=oom.git;a=tree;f=kubernetes/dcaegen2-services/resources/external>`_ repository and installed with dcaegen2 module, follow below steps.

 

-.. note:: 

+.. note::

   For more information on generating schema files, see `External-schema-repo-generator (OOM Utils repository) <https://gerrit.onap.org/r/gitweb?p=oom/utils.git;a=tree;f=external-schema-repo-generator>`_

-  

+

   Default ONAP deployment for Istanbul release makes available the SA88-Rel16 OpenAPI schema files; optionally SA99-Rel16 files can be loaded using the `Generator script <https://gerrit.onap.org/r/gitweb?p=oom/utils.git;a=blob;f=external-schema-repo-generator/generator/generate.sh>`_ based on the steps documented in `README <https://git.onap.org/oom/utils/tree/external-schema-repo-generator/README.md>`_

 

 

@@ -89,7 +91,7 @@ E.g:
         optional: true

       - name: 'dev-dcae-external-repo-configmap-sa88-rel16'

         type: configmap

-        mountPath: /opt/app/VESCollector/etc/externalRepo/3gpp/rep/sa5/MnS/blob/SA88-Rel16/OpenAPI 

+        mountPath: /opt/app/VESCollector/etc/externalRepo/3gpp/rep/sa5/MnS/blob/SA88-Rel16/OpenAPI

         optional: true

 

 If more than a single external schema is required add new config map to object 'externalVolumes' like in above example. Make sure that all external schemas (all openAPI files) are reflected in the schema-map file.

@@ -112,10 +114,10 @@ Using external TLS certificates obtained using CMP v2 protocol
 

 In order to use the X.509 certificates obtained from the CMP v2 server (so called "operator`s certificates"), refer to the following description:

 

-:ref:`Enabling TLS with external x.509 certificates <external-tls-helm>`

+:ref:`Enabling TLS with external x.509 certificates <tls_enablement>`

 

 Example values for VES Collector:

-    .. code-block:: bash

+    .. code-block:: yaml

 

         global:

           cmpv2Enabled: true

@@ -135,4 +137,3 @@ Example values for VES Collector:
                 name: ves-cmpv2-keystore-password

                 key: password

                 create: true

-

diff --git a/docs/sections/services/ves-http/stnd-defined-validation.rst b/docs/sections/services/ves-http/stnd-defined-validation.rst
index 6449922e..6089e662 100644
--- a/docs/sections/services/ves-http/stnd-defined-validation.rst
+++ b/docs/sections/services/ves-http/stnd-defined-validation.rst
@@ -253,9 +253,9 @@ scenario.
     +---------------------+------------------------------------------------------------------+
     | Text                | "Invalid input value for %1 %2: %3"                              |
     +---------------------+------------------------------------------------------------------+
-    | Variables           | %1 – “attribute”                                                 |
-    |                     | %2 – "event.stndDefinedFields.schemaReference"                   |
-    |                     | %3 – "Referred external schema not present in schema repository" |
+    | Variables           | %1 - "attribute"                                                 |
+    |                     | %2 - "event.stndDefinedFields.schemaReference"                   |
+    |                     | %3 - "Referred external schema not present in schema repository" |
     +---------------------+------------------------------------------------------------------+
     | HTTP status code(s) | 400 Bad request                                                  |
     +---------------------+------------------------------------------------------------------+
@@ -301,8 +301,8 @@ scenario.
     +---------------------+-----------------------------------------------------+
     | Text                | Mandatory input %1 %2 is missing from request       |
     +---------------------+-----------------------------------------------------+
-    | Variables           | %1 – “attribute”                                    |
-    |                     | %2 – "event.commonEventHeader.stndDefinedNamespace" |
+    | Variables           | %1 - "attribute"                                    |
+    |                     | %2 - "event.commonEventHeader.stndDefinedNamespace" |
     +---------------------+-----------------------------------------------------+
     | HTTP status code(s) | 400 Bad Request                                     |
     +---------------------+-----------------------------------------------------+
@@ -316,8 +316,8 @@ scenario.
     +---------------------+-----------------------------------------------------+
     | Text                | Mandatory input %1 %2 is empty in request           |
     +---------------------+-----------------------------------------------------+
-    | Variables           | %1 – “attribute”                                    |
-    |                     | %2 – "event.commonEventHeader.stndDefinedNamespace" |
+    | Variables           | %1 - "attribute"                                    |
+    |                     | %2 - "event.commonEventHeader.stndDefinedNamespace" |
     +---------------------+-----------------------------------------------------+
     | HTTP status code(s) | 400 Bad Request                                     |
     +---------------------+-----------------------------------------------------+
@@ -331,12 +331,9 @@ scenario.
     +---------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
     | Text                | "Invalid input value for %1 %2: %3"                                                                                                       |
     +---------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
-    | Variables           | %1 – “attribute”                                                                                                                          |
-    |                     | %2 – "event.commonEventHeader.stndDefinedNamespace"                                                                                       |
-    |                     | %3 – "stndDefinedNamespace received not present in VES Collector routing configuration. Unable to route event to appropriate DMaaP topic" |
+    | Variables           | %1 - "attribute"                                                                                                                          |
+    |                     | %2 - "event.commonEventHeader.stndDefinedNamespace"                                                                                       |
+    |                     | %3 - "stndDefinedNamespace received not present in VES Collector routing configuration. Unable to route event to appropriate DMaaP topic" |
     +---------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
     | HTTP status code(s) | 400 Bad request                                                                                                                           |
     +---------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
-
-
-
diff --git a/docs/sections/services/ves-http/tls-authentication.rst b/docs/sections/services/ves-http/tls-authentication.rst
index 12301383..d13fa305 100644
--- a/docs/sections/services/ves-http/tls-authentication.rst
+++ b/docs/sections/services/ves-http/tls-authentication.rst
@@ -1,5 +1,6 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
+
 .. raw:: html
 
     <style> .red {color:red} </style>