correct documentation rst file errors and warnings

DMAAP-165
Signed-off-by: rn509j <rn509j@att.com>
Change-Id: Ib4851c46dc8ac35059a34fd3be837a6c39509591

diff --git a/docs/Installation/Installation.rst b/docs/Installation/Installation.rst
index 17636ff..5232bd4 100644 (file)
--- a/docs/Installation/Installation.rst
+++ b/docs/Installation/Installation.rst
@@ -27,7 +27,7 @@ kafka runs on 172.18.0.2 and dmaap on 172.18.0.4.
    \r
    .. code:: bash\r
    \r
-               docker-compose up \96d\r
+               docker-compose up  # add -d argument to start process as a daemon (background process)\r
 \r
    This should start 3 containers.\r
 \r

diff --git a/docs/message-router/message-router.rst b/docs/message-router/message-router.rst
index d441477..43799a7 100644 (file)
--- a/docs/message-router/message-router.rst
+++ b/docs/message-router/message-router.rst
@@ -58,7 +58,7 @@ are not inspected for content.
 | Content-Type            |  Description                                                                                                    |\r
 +=========================+=================================================================================================================+\r
 | text/plain              | Each line in the POST body is treated as a separate message. No partition key is specified, and therefore no    |\r
-|                         |    order is guaranteed. This format is mainly for test, as messages are highly likely to be re-ordered when        |\r
+|                         | order is guaranteed. This format is mainly for test, as messages are highly likely to be re-ordered when        |\r
 |                         | delivered through the Kafka cluster.                                                                            |\r
 +-------------------------+-----------------------------------------------------------------------------------------------------------------+\r
 | application/json        | The payload maybe a single JSON object or a JSON array of JSON objects. Each object is handled as an individual |\r
@@ -66,7 +66,7 @@ are not inspected for content.
 |                         | That's because MR uses a standard JSON parser to read each object into memory before pushing the object to the  |\r
 |                         | Kafka system. At that point, the JSON object is re-written from the in-memory object. This can result in        |\r
 |                         | re-ordered fields or changes in whitespace. If you want to preseve JSON objects exactly,                        |\r
-|                                                | use application/cambria. Recommended to follow the JSON format.                                                 |\r
+|                         | use application/cambria. Recommended to follow the JSON format.                                                 |\r
 +-------------------------+-----------------------------------------------------------------------------------------------------------------+\r
 \r
 Publishers\r
@@ -211,16 +211,17 @@ Request Parameters:
 +--------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+------------------------+\r
 | Name         | Description                     |  Param Type      |  data type |   MaxLen     |  Required   |  Format             |  Valid/Example Values  |\r
 +==============+=================================+==================+============+==============+=============+=====================+========================+\r
-| Topicname    | topic name to be posted         |     Path         |   String   |    40        |     Y       | namespace.String    |                                           |\r
+| Topicname    | topic name to be posted         |     Path         |   String   |    40        |     Y       | namespace.String    |                        |\r
 +--------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+------------------------+\r
 | Consumer     | A name that uniquely identifies |     Path         |   String   |              |     Y       |                     | CG1                    |\r
 | group        | your subscribers                |                  |            |              |             |                     |                        |\r
 +--------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+------------------------+\r
 | consumerId   | Within your subscribers group,  |     Path         |   String   |              |     Y       |                     | C1                     |\r
 |              | a name that uniquely identifies |                  |            |              |             |                     |                        |\r
-|                         | your subscribers  process       |                  |            |              |             |                     |                        | +--------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+------------------------+\r
+|              | your subscribers  process       |                  |            |              |             |                     |                        |\r
++--------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+------------------------+\r
 | content-type | To specify type of message      |     Header       |   String   |     20       |     N       |                     | aplication/json        |\r
-|                         | content(json,text or cambria)   |                  |            |              |             |                     |                        |\r
+|              | content(json,text or cambria)   |                  |            |              |             |                     |                        |\r
 +--------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+------------------------+\r
 | Username     | userid                          |     Header       |   String   |     1        |     N       |                     |                        |\r
 +--------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+------------------------+\r
@@ -269,13 +270,17 @@ Response /Error Codes
 +=========================+=================+============================+=============================================================================================+\r
 | DMaaP\_MR\_ERR\_3008    | 413             | Request Entity too large   | Message size exceeds the batch limit <limit>.Reduce the batch size and try again            |\r
 +-------------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------+\r
-| DMaaP\_MR\_ERR\_3009    | 500             | Internal Server Error      | Unable to publish messages. Please contact administartor                                    | +-------------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------+\r
-| DMaaP\_MR\_ERR\_3010    | 400             | Bad Request                | Incorrect Batching format. Please correct the batching format and try again                 | +-------------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------+\r
-| DMaaP\_MR\_ERR\_3011    | 413             | Request Entity too large   | Message size exceeds the message size limit <limit>.Reduce the message size and try again   | +-------------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------+\r
+| DMaaP\_MR\_ERR\_3009    | 500             | Internal Server Error      | Unable to publish messages. Please contact administartor                                    |\r
++-------------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------+\r
+| DMaaP\_MR\_ERR\_3010    | 400             | Bad Request                | Incorrect Batching format. Please correct the batching format and try again                 |\r
++-------------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------+\r
+| DMaaP\_MR\_ERR\_3011    | 413             | Request Entity too large   | Message size exceeds the message size limit <limit>.Reduce the message size and try again   |\r
++-------------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------+\r
 | DMaaP\_MR\_ERR\_5012    | 429             | Too many requests          | This client is making too many requests. Please use a long poll setting to decrease the     | \r
 |                         |                 |                            | number of requests that result in empty responses.                                          |\r
 +-------------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------+\r
-|                         | 503             | Service Unavailable        | Service Unavailable.                                                                        | +-------------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------+\r
+|                         | 503             | Service Unavailable        | Service Unavailable.                                                                        |\r
++-------------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------+\r
 \r
 Sample Request:\r
 ===============\r
@@ -339,10 +344,14 @@ Request Parameters:
 +-------------------------+-----------------+--------------------------------------------------+\r
 | Error code              |  HTTP Code      |  Description                                     |\r
 +=========================+=================+==================================================+\r
-| DMaaP\_MR\_ERR\_5001    | 500             | Failed to retrieve list of all topics            | +-------------------------+-----------------+--------------------------------------------------+\r
-| DMaaP\_MR\_ERR\_5002    | 500             | Failed to retrieve details of topic:<topicName>  |     +-------------------------+-----------------+--------------------------------------------------+\r
-| DMaaP\_MR\_ERR\_5003    | 500             | Failed to create topic:<topicName>               | +-------------------------+-----------------+--------------------------------------------------+\r
-| DMaaP\_MR\_ERR\_5004    | 500             | Failed to delete topic:<topicName>               | +-------------------------+-----------------+--------------------------------------------------+\r
+| DMaaP\_MR\_ERR\_5001    | 500             | Failed to retrieve list of all topics            |\r
++-------------------------+-----------------+--------------------------------------------------+\r
+| DMaaP\_MR\_ERR\_5002    | 500             | Failed to retrieve details of topic:<topicName>  |\r
++-------------------------+-----------------+--------------------------------------------------+\r
+| DMaaP\_MR\_ERR\_5003    | 500             | Failed to create topic:<topicName>               |\r
++-------------------------+-----------------+--------------------------------------------------+\r
+| DMaaP\_MR\_ERR\_5004    | 500             | Failed to delete topic:<topicName>               |\r
++-------------------------+-----------------+--------------------------------------------------+\r
 \r
 \r
 Response Parameters\r