From 02a34e76df822200b213f84d0394e69e4457231a Mon Sep 17 00:00:00 2001 From: Satyaki Mallick Date: Wed, 24 Oct 2018 16:12:36 +0530 Subject: [PATCH] Documentation Enhancement Documentation Enhancement for SDC Issue-ID: SDC-1841 Change-Id: I32c52bf817ceccf5ebc5621c36e5ebc722556196 Signed-off-by: Satyaki Mallick --- catalog-be/README.txt | 6 +++--- docs/logging.rst | 2 +- docs/sdcsdks.rst | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/catalog-be/README.txt b/catalog-be/README.txt index 575484081f..0fa113be2a 100644 --- a/catalog-be/README.txt +++ b/catalog-be/README.txt @@ -13,7 +13,7 @@ STOP.KEY=[alphanumeric] The passphrase defined to stop the server. - Requried along with STOP.PORT if you want to use the --stop option above. + Required along with STOP.PORT if you want to use the --stop option above. STOP.WAIT=[number] The time (in seconds) to wait for confirmation that the running @@ -22,8 +22,8 @@ #Upload Normative types: -# 1. create zip file containing the yaml -# 2. create json string (payloadName should be the yml file name): { +# 1. create a zip file containing the yaml +# 2. create a json string (payloadName should be the yml file name): { # "payloadName":"normative-types-new-root.yml", # "userId":"adminid", # "resourceName":"tosca.nodes.Root", diff --git a/docs/logging.rst b/docs/logging.rst index a1e3a659c0..8c1bd11847 100644 --- a/docs/logging.rst +++ b/docs/logging.rst @@ -7,7 +7,7 @@ Logging Where to Access Information --------------------------- -the logs for the application are available in the docker it self at /var/lib/jetty/logs/ +the logs for the application are available in the docker itself at /var/lib/jetty/logs/ in Heat deployment the dockers are mapped into /data/logs on the vm where the application is running. In OOM you can use the logging project to access the logging collected from the applications. diff --git a/docs/sdcsdks.rst b/docs/sdcsdks.rst index d35ce4d5e8..db4e6690da 100644 --- a/docs/sdcsdks.rst +++ b/docs/sdcsdks.rst @@ -29,13 +29,13 @@ SDC-TOSCA and SDC-DISTRIBUTION-CLIENT SDC-TITAN-CASSANDRA ------------------- -| This is a link to the github page of titan project for extra reading regarding Titan DB: ``_ +| This is a link to the github page of Titan Project for extra reading regarding Titan DB: ``_ | | SDC forked part of the project to override the default Titan configuration for Cassandra. | The change allows the use of Titan as an active passive deployment for geo-redundancy. | | Titan by default uses QUORUM in Cassandra on write and read operations. | Using our change allows the use of local QUORUM to read and write only to a specific data center. -| Since the project is in end of life state the change cannot be merged back to the project. +| Since the project is at the end of life state the change cannot be merged back to the project. -- 2.16.6