Documentation clean-up

Cleaned up documentation per:
(1) Docs project feedback
(2) License cleanup
(3) other typos, etc.

Issue-ID: VNFSDK-129

Change-Id: If125784b3b0656128ca897e82ad0e5d9873a7e07
Signed-off-by: Chris Donley <christopher.donley@huawei.com>

10 files changed, 178 insertions, 89 deletions

diff --git a/docs/files/VNF SDK - Guide for Bundling VNFs.rst b/docs/files/VNF SDK - Guide for Bundling VNFs.rst
index 2cb1556..99f3ccf 100644
--- a/docs/files/VNF SDK - Guide for Bundling VNFs.rst
+++ b/docs/files/VNF SDK - Guide for Bundling VNFs.rst
@@ -1,4 +1,8 @@
-VNF SDK - Guide for Bundling VNFs
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2017 Huawei Technologies Co., Ltd.
+
+VNF SDK - Guide for Bundling VNFs
 =================================
 
 
@@ -6,7 +10,8 @@ Step 1: Requirements
 --------------------
 
 1. Virtual machine images for each of your VDUs (likely in qcow2 format).
-2. Scripts for installing and configuring each VDU per the standard TOSCA lifecycle workflows.
+2. Scripts for installing and configuring each VDU per the standard TOSCA
+   lifecycle workflows.
 3. Optional: scripts for retrieving indicators from each VDU.
 4. VNF SDK pkgtools
 
@@ -28,35 +33,38 @@ The "dependency" requirement should have a relationship of type
 
 There are two optional properties you can assign to this relationship:
 
-1. "indicators" is a map of indicators. The keys are arbitrary, for you to name,
-   and depend on the specific capabilities of your VNF. These provide the link
-   between TOSCA and your indicator retrieval scripts.
-2. "compute_dependencies" is a map of features you require the infrastructure to
-   provide for the compute node hosting your VDU. The keys are arbitrary, however
-   we will maintain a master list of names supported by various orchestrators
-   (TBD). Note that new names will likely be supported in the future as
-   technological innovation progresses, while deprecated ones will be ignored by
-   orchestrators. Likewise, names unsupported by a particular orchestrator will
-   be ignored.
+1. "indicators" is a map of indicators. The keys are arbitrary, for you to
+   name, and depend on the specific capabilities of your VNF. These provide
+   the link between TOSCA and your indicator retrieval scripts.
+2. "compute_dependencies" is a map of features you require the infrastructure
+   to provide for the compute node hosting your VDU. The keys are arbitrary,
+   however we will maintain a master list of names supported by various
+   orchestrators (TBD). Note that new names will likely be supported in the
+   future as technological innovation progresses, while deprecated ones will be
+   ignored by orchestrators. Likewise, names unsupported by a particular
+   orchestrator will be ignored.
 
 Notes:
 
-1. For "compute_dependencies", you have the option of specifying a single special key, "profile", that refers to a bundle of compute dependencies specified in
-   "compute-profiles.yaml". Optionally, you can override any of the dependencies
-   in the bundle by specifying them explicitly under "compute_dependencies".
+1. For "compute_dependencies", you have the option of specifying a single
+   special key, "profile", that refers to a bundle of compute dependencies
+   specified in "compute-profiles.yaml". Optionally, you can override any of
+   the dependencies in the bundle by specifying them explicitly under
+   "compute_dependencies".
 2. By default, compute dependencies are considered to be absolute requirements
-   for your VNF to function. However, if your VNF can also function without them,
-   you can set "optional: true". This way the orchestrator will try to satisfy
-   the optional requirements, but will not report an error if it cannot.
-3. You may optionally consider allowing operators to override your dependencies.
-   This is useful for allowing the VNF to run on various compute infrastructures
-   other than the defaults you specify, as long as they are indeed supported by
-   your VNF. In TOSCA, this is easily handled by declaring "inputs" for your
-   blueprint, with "default" values, and then using the "get_input" intrinsic
-   function to apply the provided value to any specific "compute_dependencies".
-   The "pingpong.yaml" has an example of such usage. The same technique can be
-   used to allow the operator to override your indicator scripts, and there is an
-   example of that as well.
+   for your VNF to function. However, if your VNF can also function without
+   them, you can set "optional: true". This way the orchestrator will try to
+   satisfy the optional requirements, but will not report an error if it
+   cannot.
+3. You may optionally consider allowing operators to override your
+   dependencies. This is useful for allowing the VNF to run on various compute
+   infrastructures other than the defaults you specify, as long as they are
+   indeed supported by your VNF. In TOSCA, this is easily handled by declaring
+   "inputs" for your blueprint, with "default" values, and then using the
+   "get_input" intrinsic function to apply the provided value to any specific
+   "compute_dependencies". The "pingpong.yaml" has an example of such usage.
+   The same technique can be used to allow the operator to override your
+   indicator scripts, and there is an example of that as well.
 
 Otherwise, this is a standard TOSCA blueprint using the Simple Profile for NFV,
 and you may extend the blueprint as is required.
@@ -68,8 +76,8 @@ Arrange all your files (the TOSCA template, your scripts, and your virtual
 machine images) in the correct directory structure. File references provided in
 the blueprint must match the directory structure. If a script is referenced
 using a path with sub-directory "example" the initial directory must contain a
-directory called "example" with that script file inside. The directory structure
-will be kept inside the CSAR archive.
+directory called "example" with that script file inside. The directory
+structure will be kept inside the CSAR archive.
 
 Run the bundling tool that is included in the VNF SDK.
 
diff --git a/docs/files/VNF SDK blueprints.rst b/docs/files/VNF SDK blueprints.rst
index 50a58ed..f0952c1 100644
--- a/docs/files/VNF SDK blueprints.rst
+++ b/docs/files/VNF SDK blueprints.rst
@@ -1,4 +1,6 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2017 Huawei Technologies Co., Ltd.
 .. SPDX-License-Identifier: CC-BY-4.0
 
 VNF SDK sample Blueprints
diff --git a/docs/files/VNFSDK-Marketplace-userguide-operators.rst b/docs/files/VNFSDK-Marketplace-userguide-operators.rst
index 20502c0..9d1b8fb 100644
--- a/docs/files/VNFSDK-Marketplace-userguide-operators.rst
+++ b/docs/files/VNFSDK-Marketplace-userguide-operators.rst
@@ -1,10 +1,22 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2017 Huawei Technologies Co., Ltd.
+
 VNF SDK Marketplace User Guide for Operators
 ============================================
 
-The VNF SDK Marketplace helps operators download pre-validated VNFs through the web GUI.
+The VNF SDK Marketplace helps operators download pre-validated VNFs through the
+web GUI.
 
 1. Log into the portal
-2. Using the buttons in the upper right corner, an operator can see the currently validated VNFs in a list or grid view.
-3. The marketplace provides an onboarding report for each VNF.  Operators can see the testing results by clicking on the VNF.  In the Amsterdam release, only validation tests are run.  In the future, we plan to add lifecycle and functional tests.
+2. Using the buttons in the upper right corner, an operator can see the
+   currently validated VNFs in a list or grid view.
+3. The marketplace provides an onboarding report for each VNF.  Operators can
+   see the testing results by clicking on the VNF.  In the Amsterdam release,
+   only validation tests are run.  In the future, we plan to add lifecycle and
+   functional tests.
 4. Operators can download a VNF by clicking on the "download" button.
-5. VNF SDK also supports integration with SDC.  A VNF can be onboarded into SDC by visiting the SDC portal.  SDC connects to VNF SDK and can query all available VNFs.  When an operator selects a VNF in the SDC portal, it will be downloaded from VNFSDK and installed in the SDC catalog.
+5. VNF SDK also supports integration with SDC.  A VNF can be onboarded into SDC
+   by visiting the SDC portal.  SDC connects to VNF SDK and can query all
+   available VNFs.  When an operator selects a VNF in the SDC portal, it will
+   be downloaded from VNFSDK and installed in the SDC catalog.
diff --git a/docs/files/VNFSDK-Marketplace-userguide-vendors.rst b/docs/files/VNFSDK-Marketplace-userguide-vendors.rst
index 8cc9234..f6385c0 100644
--- a/docs/files/VNFSDK-Marketplace-userguide-vendors.rst
+++ b/docs/files/VNFSDK-Marketplace-userguide-vendors.rst
@@ -1,15 +1,25 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2017 Huawei Technologies Co., Ltd.
+
 VNF SDK Marketplace User Guide for Vendors
 ==========================================
 
-The VNF SDK Marketplace helps vendors validate VNFs and connect with suppliers.  To upload and validate VNFs, vendors will use the web GUI.
+The VNF SDK Marketplace helps vendors validate VNFs and connect with suppliers.
+To upload and validate VNFs, vendors will use the web GUI.
 
 1. Log into the portal
-2. Click "upload" in the upper right to upload a VNF. Select the file and enter a short description and details.
-3. The file is uploaded into the system and the marketplace automatically starts the VNF validation process.
+2. Click "upload" in the upper right to upload a VNF. Select the file and enter
+   a short description and details.
+3. The file is uploaded into the system and the marketplace automatically
+   starts the VNF validation process.
 4. Once validation is complete, the VNF is installed in the marketplace.
-5. A vendor can re-upload a VNF if there are changes by clicking the "re-upload" button.
+5. A vendor can re-upload a VNF if there are changes by clicking the
+   "re-upload" button.
 6. A vendor can also delete a VNF by clicking the "delete" button.
-7. Using the buttons in the upper right corner, a user can see a list or grid of VNFs.
-8. The marketplace provides an onboarding report for each VNF.  You can see the testing results by clicking on the VNF.  In the Amsterdam release, only validation tests are run.  In the future, we plan to add lifecycle and functional tests.
-
-
+7. Using the buttons in the upper right corner, a user can see a list or grid
+   of VNFs.
+8. The marketplace provides an onboarding report for each VNF.  You can see the
+   testing results by clicking on the VNF.  In the Amsterdam release, only
+   validation tests are run.  In the future, we plan to add lifecycle and
+   functional tests.
diff --git a/docs/files/marketplace-overview.rst b/docs/files/marketplace-overview.rst
index 18a5da9..bf4d8e4 100644
--- a/docs/files/marketplace-overview.rst
+++ b/docs/files/marketplace-overview.rst
@@ -1,7 +1,13 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2017 Huawei Technologies Co., Ltd.
+
 VNF SDK Marketplace
 ===================
 
-VNF SDK provides a reference implementation "marketplace" to help vendors validate and manage VNF packages. It also supports the operator to onboard VNF into ONAP.
+VNF SDK provides a reference implementation "marketplace" to help vendors
+validate and manage VNF packages. It also supports the operator to onboard VNF
+into ONAP.
 
 |image0|
 
@@ -16,14 +22,25 @@ VNF SDK provides a reference implementation "marketplace" to help vendors valida
         ii. Download VNF
         iii. Query VNF based on several parameters
         iv. Delete VNF
-    b. It also provides an intuitive Graphical user interface to perform above activities.
+    b. It also provides an intuitive Graphical user interface to perform above
+       activities.
 
+2.  Along with these, VNF SDK also provides hooks to call other tools or
+    libraries including **Validation and Function Tests**.
 
-2.  Along with these, VNF SDK also provides hooks to call other tools or libraries including **Validation and Function Tests**.
+    a. Validation verifies the package structure, mandatory files and their
+    format. Currently, the tool performs basic validation to support SDC. In a
+    future release, it will also ensure integrity and authenticity of the
+    package as described by VNF Requirements.
 
-    a. Validation verifies the package structure, mandatory files and their format. Currently, the tool performs basic validation to support SDC. In a future release, it will also ensure integrity and authenticity of the package as described by VNF Requirements.
-    b. Function Test provides Robot framework test cases present in each VNF. Function test executes those test cases and send the test response back to the marketplace. While the framework is in place, actual test development is deferred for a future release.
+    b. Function Test provides Robot framework test cases present in each VNF.
+    Function test executes those test cases and send the test response back to
+    the marketplace. While the framework is in place, actual test development
+    is deferred for a future release.
 
 3. **VNF SDK Integration with SDC**
 
-    a. In Amsterdam release, the SDC-UI is being integrated with the VNF Repository backend. It provides seamless download, search, view of the VNF present in VNF repository. The user can onboard these validated VNF into the SDC catalogue.
+    a. In Amsterdam release, the SDC-UI is being integrated with the VNF
+    Repository backend. It provides seamless download, search, view of the VNF
+    present in VNF repository. The user can onboard these validated VNF into
+    the SDC catalogue.
diff --git a/docs/files/mktplace-install.rst b/docs/files/mktplace-install.rst
index 58e65a8..6df2ef0 100644
--- a/docs/files/mktplace-install.rst
+++ b/docs/files/mktplace-install.rst
@@ -1,5 +1,9 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2017 Huawei Technologies Co., Ltd.
+
 VNF SDK Marketplace Installation Instructions
-============================================
+=============================================
 
 1. Download vnfsdk/refrepo from Gerrit
 ::
diff --git a/docs/files/pkgtool.rst b/docs/files/pkgtool.rst
index 36e582e..9325da9 100644
--- a/docs/files/pkgtool.rst
+++ b/docs/files/pkgtool.rst
@@ -1,16 +1,27 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2017 Huawei Technologies Co., Ltd.
+
 VNF Package Tool
 ================
 
 Provided tools
 --------------
 
-* VNF Package Builder - creates a CSAR file based on inputs provided by the VNF product DevOps engineer
-* VNF Package Validator - validates the content of the VNF packages to ensure that everything has been built correctly
-* VNF Package Extractor - extracts VNF product model and executables from the CSAR file
-* VNF Package Parser - translates VNF product blueprint into a format consumable by ONAP components
-* VNF Package Dry Run - performs a "dry run" install to ensure that the package can be deployed during instantiation
-
-The tools are provided in a form of a shared library (Python module) that can be used in other projects. A CLI is also provided out-of-the box for DevOps to use the library with their scripts and autoamtion framework.
+* VNF Package Builder - creates a CSAR file based on inputs provided by the VNF
+  product DevOps engineer
+* VNF Package Validator - validates the content of the VNF packages to ensure
+  that everything has been built correctly
+* VNF Package Extractor - extracts VNF product model and executables from the
+  CSAR file
+* VNF Package Parser - translates VNF product blueprint into a format
+  consumable by ONAP components
+* VNF Package Dry Run - performs a "dry run" install to ensure that the package
+  can be deployed during instantiation
+
+The tools are provided in a form of a shared library (Python module) that can
+be used in other projects. A CLI is also provided out-of-the box for DevOps to
+use the library with their scripts and autoamtion framework.
 
 Repository Name: vnfsdk/pkgtools
 
@@ -18,7 +29,9 @@ Clone command: git clone http://gerrit.onap.org/r/vnfsdk/pkgtools
 
 Installation
 ------------
-Python module with CLI is installed by Python pip command. It is possible to install into a virtual environment (virtualenv).
+Python module with CLI is installed by Python pip command. It is possible to
+install into a virtual environment (virtualenv).
+
 The following commands are executed in the cloned repository directory:
 
 1. pip install -r requirements.txt
@@ -34,7 +47,8 @@ Install VNF SDK tools package
 Usage
 
 * Create CSAR by specifying a directory
-    vnfsdk csar-create -d DESTINATION [--manifest MANIFEST] [--history HISTORY] [--tests TESTS] [--licenses LICENSES] source entry
+    vnfsdk csar-create -d DESTINATION [--manifest MANIFEST] [--history HISTORY]
+    [--tests TESTS] [--licenses LICENSES] source entry
 
 * Extract CSAR content
     vnfsdk csar-open -d DESTINATION source
@@ -43,4 +57,5 @@ Usage
     vnfsdk csar-validate source
 
 
-All commands have -h switch which displays help and description of all paramaters.
+All commands have -h switch which displays help and description of all
+paramaters.
diff --git a/docs/files/vnfsdk-apis.rst b/docs/files/vnfsdk-apis.rst
index b6819f9..a16fd8c 100644
--- a/docs/files/vnfsdk-apis.rst
+++ b/docs/files/vnfsdk-apis.rst
@@ -1,6 +1,6 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
-
+.. Copyright 2017 Huawei Technologies Co., Ltd.
 
 VNF SDK APIs
 ============
diff --git a/docs/index.rst b/docs/index.rst
index 9ecdee7..f5dbab4 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -2,7 +2,6 @@
 .. http://creativecommons.org/licenses/by/4.0
 .. Copyright 2017 Huawei Technologies Co., Ltd.
 
-
 VNFSDK Documentation
 ====================
 
@@ -18,13 +17,23 @@ Components
 VNF Packaging Model/Blueprint
 -----------------------------
 
-VNF product model/blueprint provides a declarative way to define deployment, operational and functional attributes of a VNF product. The VNF product is defined in terms of deployment time requirements and dependencies and exposed telemetry indicator definitions.
+VNF product model/blueprint provides a declarative way to define deployment,
+operational and functional attributes of a VNF product. The VNF product is
+defined in terms of deployment time requirements and dependencies and exposed
+telemetry indicator definitions.
 
-The deployment time requirements and dependencies define any and all compute infrastructure needs of the VNF product, such as specific hardware architecture, on-chip features, instruction set availability and hypervisor capabilities.
+The deployment time requirements and dependencies define any and all compute
+infrastructure needs of the VNF product, such as specific hardware
+architecture, on-chip features, instruction set availability and hypervisor
+capabilities.
 
-The telemetry indicator definitions define a set of default indicators exposed by a given VNF product for use by monitoring and assurance tools. This list can be extended and customized once a given VNF product is on-boarded and instantiated at run-time.
+The telemetry indicator definitions define a set of default indicators exposed
+by a given VNF product for use by monitoring and assurance tools. This list
+can be extended and customized once a given VNF product is on-boarded and
+instantiated at run-time.
 
-The VNF product model is specified using the TOSCA NFV simple profile. It is persisted, along with the product executables and data, using TOSCA CSAR files.
+The VNF product model is specified using the TOSCA NFV simple profile. It is
+persisted, along with the product executables and data, using TOSCA CSAR files.
 
 .. toctree::
    :maxdepth: 1
@@ -50,17 +59,20 @@ Installation instructions
 VNF SDK Tools
 -------------
 
-VNF SDK tools provide VNF product DevOps engineers with command line tools and client side API language bindings to define the VNF product model and package content. The following tools are included...
-
-•	VNF Package Builder - creates a CSAR file based on inputs provided by the VNF product DevOps engineer
-
-•	VNF Package Validator - validates the content of the VNF packages to ensure that everything has been built correctly
+VNF SDK tools provide VNF product DevOps engineers with command line tools and
+client side API language bindings to define the VNF product model and package
+content. The following tools are included...
 
-•	VNF Package Extractor - extracts VNF product model and executables from the CSAR file
-
-•	VNF Package Parser - translates VNF proeduct blueprint into a format consumable by ONAP components
-
-•	VNF Package Dry Run - performs a "dry run" install to ensure that the package can be deployed during instantiation
+•	VNF Package Builder - creates a CSAR file based on inputs provided by the VNF
+product DevOps engineer
+•	VNF Package Validator - validates the content of the VNF packages to ensure
+that everything has been built correctly
+•	VNF Package Extractor - extracts VNF product model and executables from the
+CSAR file
+•	VNF Package Parser - translates VNF proeduct blueprint into a format
+consumable by ONAP components
+•	VNF Package Dry Run - performs a "dry run" install to ensure that the package
+can be deployed during instantiation
 
 
 User Guides
@@ -69,7 +81,12 @@ User Guides
 VNF Package Tools User Guide
 ----------------------------
 
-VNF Package Designer, provides VNF product DevOps engineers with a graphical tool to define the VNF product model and package content. It is made available as part of the VNF Supplier SDK tools.The package designer makes use of the VNF SDK command line interfaces (CLIs) and client-side API language bindings in order to define the model and the package content. As such, it is functionally equivalent to the VNF SDK tools.
+VNF Package Designer, provides VNF product DevOps engineers with a graphical
+tool to define the VNF product model and package content. It is made available
+as part of the VNF Supplier SDK tools.The package designer makes use of the VNF
+SDK command line interfaces (CLIs) and client-side API language bindings in
+order to define the model and the package content. As such, it is functionally
+equivalent to the VNF SDK tools.
 
 .. toctree::
    :maxdepth: 1
@@ -105,4 +122,3 @@ VES Client Guidelines
 
    files/VESEventRegistration
    files/VESEventListener
-
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index 907f63b..8e92725 100644
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -6,10 +6,12 @@ Release Notes
 =============
 
 .. note::
-VNF onboarding is a challenge across the industry because of the lack of a standard format for VNFs.
-This project provides an ecosystem for ONAP compatible VNFs by:
-* developing tools for vendor CI/CD toolchains
-* developing validation and testing tools
+   VNF onboarding is a challenge across the industry because of the lack of a
+   standard format for VNFs.
+   This project provides an ecosystem for ONAP compatible VNFs by:
+
+   * developing tools for vendor CI/CD toolchains
+   * developing validation and testing tools
 
 Version: 1.0.0
 --------------
@@ -21,25 +23,28 @@ Version: 1.0.0
 
 **New Features**
 
-The VNF SDK project delivers a set of tools designed to expand the VNF ecosystem for ONAP.
+The VNF SDK project delivers a set of tools designed to expand the VNF
+ecosystem for ONAP.
+
 It provides:
 
 * VNF packaging tools, which bundle VNFs into an ONAP-compliant TOSCA CSAR file
-* VNF Marketplace, which sits between VNF suppliers and operators. It provides a repository
-     for uploading and downloading VNFs and tools to validate package consistency.
+* VNF Marketplace, which sits between VNF suppliers and operators. It provides
+  a repository for uploading and downloading VNFs and tools to validate package
+  consistency.
 * VES Collector that may optionally be incorporated into VNFs
 
 VNF SDK works with SDC to facilitate VNF Onboarding.
 
 **Bug Fixes**
+N/A
 **Known Issues**
+N/A
 **Security Issues**
-
-
+N/A
 **Upgrade Notes**
-
+N/A
 **Deprecation Notes**
-
+N/A
 **Other**
-
-===========
+N/A