Fix minor typos in documentation

Change-Id: I0c1468fc0f7f9a03ee7c23c2ca1b9debd136c671
Issue-ID: SDC-2315
Signed-off-by: kaihlavi <l.kaihlavirt@partner.samsung.com>
(cherry picked from commit e9135d23dcf8f7822ed46a1031d078d3d295f6a7)

diff --git a/docs/architecture.rst b/docs/architecture.rst
index 142b458..c2e8999 100644 (file)
--- a/docs/architecture.rst
+++ b/docs/architecture.rst
@@ -20,12 +20,12 @@ The following diagram shows the high-level relationship between the system compo
 The SDC architecture uses the Jetty server as an application server.
 
 - The **Jetty front end**:
-   - supplies the static content of web pages, and all resources that required by the GUI
+   - supplies the static content of the web pages and all the resources that are required by the GUI
    - serves as a proxy for the REST API requests coming from the GUI
    
   Every request originating from the GUI is passed to the Jetty front-end server before it is executed.
 
-- The **Jetty back end** containers all the logic for the SDC.
+- The **Jetty back end** contains all the logic for the SDC.
 
 SDC uses two storage components: Elastic Search(ES) and Cassandra
 

diff --git a/docs/configuration.rst b/docs/configuration.rst
index cf1bcd3..d9aaea1 100644 (file)
--- a/docs/configuration.rst
+++ b/docs/configuration.rst
@@ -183,7 +183,7 @@ BE-configuration.yaml
     # Titan configuration file location
     titanCfgFile: /var/lib/jetty/config/catalog-be/titan.properties
 
-    # Does titan holds the persistence data in memory
+    # Does titan hold the persistence data in memory
     titanInMemoryGraph: false
 
     # The timeout for titan to lock on an object in a transaction
@@ -247,7 +247,7 @@ BE-configuration.yaml
         # The amount of time the Cassandra client will wait for a response
         socketConnectTimeout: <%= @socket_connect_timeout %>
 
-        # Should an authentication be used when accessing Cassandra
+        # Should authentication be used when accessing Cassandra
         authenticate: true
 
         # Username for accessing Cassandra
@@ -256,7 +256,7 @@ BE-configuration.yaml
         # Password for accessing Cassandra
         password: {{cassandra_password}}
 
-        # Does an ssl should be used
+        # Should ssl be used
         ssl: false
 
         # Location of .truststore file
@@ -361,7 +361,7 @@ BE-configuration.yaml
             fileExtension: "env"
 
     # Tosca artifacts placeholders
-    # For each artifact there is a template and a scar.
+    # For each artifact there is a template and a csar.
     # For each one the following properties exists:
     #
     # artifactName - The suffix of the artifact file
@@ -910,7 +910,7 @@ BE-configuration.yaml
             forBaseModule: Base
             forNonBaseModule: Expansion
 
-    # For each generic node type defining it's corresponding class
+    # For each generic node type defining its corresponding class
     genericAssetNodeTypes:
         VFC: org.openecomp.resource.abstract.nodes.VFC
         CVFC: org.openecomp.resource.abstract.nodes.VFC
@@ -976,7 +976,7 @@ BE-configuration.yaml
         #  - c.d.e
         #CR:
         #  - x.y.z
-    # defanition for group types that cannot by created by api
+    # definition for group types that cannot by created by api
     excludedGroupTypesMapping:
         CR:
            - org.openecomp.groups.VfModule
@@ -1079,7 +1079,7 @@ BE-distribution-engine-configuration.yaml
     startDistributionEngine: true
 
     #This is false by default, since ONAP Dmaap currently doesn't support https
-    # Does https should be used with Dmaap
+    # Should https be used with Dmaap
     useHttpsWithDmaap: false
     opEnvRecoveryIntervalSec: 180
     allowedTimeBeforeStaleSec: 300
@@ -1129,7 +1129,7 @@ BE-titan.properties
     # Titan storage hostname
     storage.hostname=<%= @CASSANDRA_IP %>
 
-    # Titan storage port]
+    # Titan storage port
     storage.port=9160
 
     # Titan storage username
@@ -1153,7 +1153,7 @@ BE-titan.properties
     # Titan cassandra ssl truststore file password
     storage.cassandra.ssl.truststore.password=Aa123456
 
-    # Does titan should use cache
+    # Should titan use cache
     cache.db-cache = false
 
     # How long in milliseconds should the cache keep entries before flushing them
@@ -1243,11 +1243,11 @@ vnfrepo-configuration.yaml
 
 ::
 
-    # The port on which the vnfsdk is licensing on
+    # The port on which the vnfsdk is licensing
     vnfRepoPort: <port>
     # The ip where vnfdk is deployed
     vnfRepoHost: <ip>
-    # The url used for querying the vnf sdk for available CSARS
+    # The url used for querying the vnf sdk for available CSARs
     getVnfUri: /onapapi/vnfsdk-marketplace/v1/PackageResource/csars
     # The url used for downloading the the CSAR from vnf sdk
     downloadVnfUri: /onapapi/vnfsdk-marketplace/v1/PackageResource/csars/%s/files
@@ -1379,9 +1379,9 @@ FE-plugins-configuration.yaml
 *****************************
 ::
 
-   # defnition of the plugins that exist in sdc
-   # we have a pre defined list of plugins that are conected to the system.
-   # the plugins define where they are shown to who and on what elements
+   # definition of the plugins that exist in sdc
+   # we have a pre-defined list of plugins that are connected to the system.
+   # the plugins define where they are shown, to whom and on what elements
    pluginsList:
         # the DCAE-DS is the SDC monitoring design studio this entry defines there use as part of the service level context
       - pluginId: DCAED
@@ -1420,7 +1420,7 @@ FE-plugins-configuration.yaml
                displayName: "WORKFLOW"
                displayRoles: ["DESIGNER", "TESTER"]
 
-   # how long we will wai for the plugin to respond before cuting it.
+   # how long we will wait for the plugin to respond before cutting it.
    connectionTimeout: 1000
 
 Onboarding configuration

diff --git a/docs/consumedapis.rst b/docs/consumedapis.rst
index 8e70210..7666209 100644 (file)
--- a/docs/consumedapis.rst
+++ b/docs/consumedapis.rst
@@ -33,10 +33,10 @@ SDC invokes Compliance Checks via VNF Test Platform (VTP)
    * - /vtp/scenarios
      - retrieve list available test scenarios
    * - /vtp/scenarios/{scenario}/testsuites
-     - retrieve a list of available test suites in given scenario
+     - retrieve a list of available test suites in a given scenario
    * - /vtp/scenarios/{scenario}/testcases
      - retrieve a list of available test cases in a given scenario
    * - /vtp/scenarios/{scenario}/testsuites/{testSuiteName}/testcases/{testCaseName}
-     - retrieve test case parameters such as  inputs and outputs in a given scenario and test suite
+     - retrieve test case parameters such as inputs and outputs in a given scenario and test suite
    * - /vtp/executions
      - execute a list of test cases

diff --git a/docs/externaltesting.rst b/docs/externaltesting.rst
index ffb6456..3787ddb 100644 (file)
--- a/docs/externaltesting.rst
+++ b/docs/externaltesting.rst
@@ -25,7 +25,7 @@ New and Impacted Code
 =====================
 
 The new code for this feature follows the software design
-of the existing onboarding BE.  New code is isolated into two
+of the existing onboarding BE. New code is isolated into two
 new subprojects contained within openecomp-be within minimal hooks
 elsewhere.
 
@@ -68,8 +68,8 @@ Configuration
 Configuration was added to the onboarding backend yaml in
 order to know the URLs to reach VTP and external testing sources.
 The full configuration is documented in the configuration section
-of this manual.   For details, see the BE-onboarding-configuration.yaml
-section.  Here is an example of the yaml.
+of this manual. For details, see the BE-onboarding-configuration.yaml
+section. Here is an example of the yaml.
 
 ::
 

diff --git a/docs/genericdesignerintegration.rst b/docs/genericdesignerintegration.rst
index 5a717f4..a1b09f4 100644 (file)
--- a/docs/genericdesignerintegration.rst
+++ b/docs/genericdesignerintegration.rst
@@ -5,10 +5,10 @@
 Generic Designer Integration
 ========
 
-plugable Architecture
+Pluggable Architecture
 ================================
 
 SDC has been working on opening the application to allow an easy integration for any designer explanations.
-the current definitions and explanations are located here.
+The current definitions and explanations are located here:
 
 `Generic Designer Support <https://wiki.onap.org/display/DW/Generic+Designer+Support/>`_

diff --git a/docs/installation.rst b/docs/installation.rst
index 960ae05..bfd9191 100644 (file)
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -15,10 +15,10 @@ For local deployment SDC offers two options:
 - `Deploying SDC on a Linux VM for Development <https://wiki.onap.org/display/DW/Deploying+SDC+on+a+Linux+VM+for+Development>`_
 - `Using Vagrant-Onap for local deployment of SDC project <https://wiki.onap.org/display/DW/Deploying+SDC+on+a+Linux+VM+for+Development>`_
 
-Colection of commends used in deploying and monitoring sdc in OOM
+Collection of commands used in deploying and monitoring sdc in OOM
 - `SDC on OOM <https://wiki.onap.org/display/DW/SDC+on+OOM>`_
 
 
 SDC troubleshooting:
 
-- `trouble shooting guide and logging info <https://wiki.onap.org/display/DW/SDC+Troubleshooting>`_
+- `troubleshooting guide and logging info <https://wiki.onap.org/display/DW/SDC+Troubleshooting>`_

diff --git a/docs/logging.rst b/docs/logging.rst
index 33a38a8..53ed7aa 100644 (file)
--- a/docs/logging.rst
+++ b/docs/logging.rst
@@ -7,9 +7,9 @@ Logging
 
 Where to Access Information
 ---------------------------
-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.
+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 loggings collected from the applications.
 
 In the OOM deployment the log location in the docker is /var/log/onap
 
@@ -22,15 +22,15 @@ In the OOM deployment the log location in the docker is /var/log/onap
 |                               | /data/logs/BE/SDC/SDC-BE/audit.log       | application audit   | An audit record is created for each operation in SDC                                                                                                                                      | rolls at 20 MB      |
 +                               +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 |                               | /data/logs/BE/SDC/SDC-BE/debug.log       | application logging | We can enable higher logging on demand by editing the logback.xml inside the server docker.                                                                                               | rolls at 20 MB      |
-|                               |                                          |                     | The file is located under:,config/catalog-be/logback.xml.                                                                                                                                 |                     |
+|                               |                                          |                     | The file is located under: config/catalog-be/logback.xml.                                                                                                                                 |                     |
 |                               |                                          |                     | This log holds the debug and trace level output of the application.                                                                                                                       |                     |
 +                               +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 |                               | /data/logs/BE/SDC/SDC-BE/error.log       | application logging | This log holds the info and error level output of the application.                                                                                                                        | rolls at 20 MB      |
 +                               +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
-|                               | /data/logs/BE/SDC/SDC-BE/transaction.log | application logging | Not currently in use. will be used in future releases.                                                                                                                                     | rolls at 20 MB      |
+|                               | /data/logs/BE/SDC/SDC-BE/transaction.log | application logging | Not currently in use, will be used in future releases.                                                                                                                                     | rolls at 20 MB      |
 +                               +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 |                               | /data/logs/BE/SDC/SDC-BE/all.log         | application logging | On demand, we can enable log aggregation into one file for easier debugging. This is done by editing the logback.xml inside the server docker.                                            | rolls at 20 MB      |
-|                               |                                          |                     | The file is located under:,config/catalog-be/logback.xml.                                                                                                                                 |                     |
+|                               |                                          |                     | The file is located under: config/catalog-be/logback.xml.                                                                                                                                 |                     |
 |                               |                                          |                     | To allow this logger, set the value for this property to true This log holds all logging output of the application.                                                                       |                     |
 +-------------------------------+------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 | FE                            | /data/logs/FE/2017_03_10.stderrout.log   |  Jetty server log   | The log describes info regarding the Jetty startup and execution                                                                                                                          | the log rolls daily |
@@ -49,24 +49,24 @@ In the OOM deployment the log location in the docker is /var/log/onap
 Changing log level
 ---------------------------
 SDC uses logback for logging.
-in order to change the level you will need to acses the docker.
-in it update the logback.xml according to your need, the change does not requir a restart to the docker.
+In order to change the level you will need to access the docker.
+Update the logback.xml inside the docker according to your need - the change does not require a restart of the docker.
 
-to change the level for all logs, change the following value:
+To change the level for all logs, change the following value:
 
 ::
 
     <root level="INFO">
 
 
-to change the level for logs of some specific packages, change the following value:
+To change the level for logs of some specific packages, change the following value:
 
 ::
 
     <logger level="INFO" name="org.openecomp.sdc" />
 
 
-to agregate all the logs level into a single log file called all.log change the foloing property to true:
+To aggregate all the logs from all levels into a single log file called all.log change the following property to true:
 
 ::
 

diff --git a/docs/offeredapis.rst b/docs/offeredapis.rst
index 8a95607..7c85b9a 100644 (file)
--- a/docs/offeredapis.rst
+++ b/docs/offeredapis.rst
@@ -5,7 +5,7 @@
 Offered APIs
 ============
 
-The list of APIs that SDC has offered could be find in the following table:
+The list of APIs that SDC offers can be found from the following table:
 
 .. |pdf-icon| image:: images/pdf.png
               :width: 40px

diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index 4525299..def505e 100644 (file)
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -58,7 +58,7 @@ SDC SDKs Versions
 
 Release Purpose
 ----------------
-The Casablanca release was focused on improving platform stability and resiliency and introducing now platform capabilities.
+The Casablanca release was focused on improving platform stability and resiliency and introducing new platform capabilities.
 
 **New Features**
 
@@ -69,7 +69,7 @@ The main goal of the Casablanca release was to:
     - Complete E2E workflow design and distribution.
     - Finalize DCAE-DS and integrate it with OOM
     - Support HPA
-    - Security enchantments
+    - Enhance security
 
 
 Security Notes

diff --git a/docs/sdcsdks.rst b/docs/sdcsdks.rst
index db4e669..df8815f 100644 (file)
--- a/docs/sdcsdks.rst
+++ b/docs/sdcsdks.rst
@@ -9,7 +9,7 @@ SDC SDKs
 SDC SDKs List
 =============
 
-The sdc projects consists of a few additional sub projects listed below:
+The sdc project consists of a few additional sub projects listed below:
 
 - sdc-tosca
 - sdc-jtosca

diff --git a/docs/workflow.rst b/docs/workflow.rst
index a0d598d..d0a9c04 100644 (file)
--- a/docs/workflow.rst
+++ b/docs/workflow.rst
@@ -8,8 +8,8 @@ SDC Workflow Designer
 README
 -------
 
-the readme file for the workflow is available  `here <https://github.com/onap/sdc-sdc-workflow-designer>`__
+The readme file for the workflow is available `here <https://github.com/onap/sdc-sdc-workflow-designer>`__
 
 Documentation
 -------------
-architecture and User guides are available `here <https://wiki.onap.org/display/DW/SDC-WORKFLOW>`__
\ No newline at end of file
+Architecture and User guides are available `here <https://wiki.onap.org/display/DW/SDC-WORKFLOW>`__