Parser Release C RC1 docs final clean up

Change-Id: Ib74e8cbaaa6397e9f9f1e9eba35d7d2f8e8d5108
Signed-off-by: zhipengh <huangzhipeng@huawei.com>

6 files changed, 170 insertions, 22 deletions

diff --git a/docs/installationprocedure/index.rst b/docs/installationprocedure/index.rst
index 13def7e..1eb7461 100644
--- a/docs/installationprocedure/index.rst
+++ b/docs/installationprocedure/index.rst
@@ -6,9 +6,21 @@
 ********************************************
 Parser Configuration and Configuration Guide
 ********************************************
+Parser is an open source project and licensed under Apache 2. Parser will help
+to provide a tooling mechanism, by parsing and then further translating Telecom
+operators deployment descriptors into certain common templates, which could be
+used in IaaS orchestration projects like OpenStack Heat(the template file is HOT,
+which stands for Heat Orchestrator Template).
+
+This document contains configuration guide for Parser's three submodules: tosca2heat,
+yang2tosca and policy2tosca. Users please refer to user guide for installation and execution
+which usually happens after configuration.
+
+
 
 .. toctree::
    :numbered:
    :maxdepth: 2
 
-   feature.configuration.rst
+.. include:: featureconfig.rst
+.. include:: installerconfig.rst
diff --git a/docs/installationprocedure/installerconfig.rst b/docs/installationprocedure/installerconfig.rst
index efe6265..1f796b2 100644
--- a/docs/installationprocedure/installerconfig.rst
+++ b/docs/installationprocedure/installerconfig.rst
@@ -2,7 +2,7 @@
 .. http://creativecommons.org/licenses/by/4.0
 .. (c) <optionally add copywriters name>
 
-Parser configuration
+Parser general configuration
 =====================
 Parser can be configured with any installer in current OPNFV.
 
@@ -19,10 +19,58 @@ Jumphost configuration
 For parser, there is not intial Jumphost configuration (network and software)needed in order
 to deploy any installer.
 
-Platform components configuration
----------------------------------
+
+Parser tosca2heat configuration
+=====================
 For tosca2heat components(tosca-parser and heat-translator) in parser,there are not specific
 configuration of each component in installer.
 
 
+Parser yang2tosca configuration
+=====================
+Parser yang2tosca requires the following to be installed.
+
+1. PYANG
+--------
+
+Please follow the below installation steps.
+
+Step 1: Clone pyang tool or download the zip file from the following link.
+
+.. code-block:: bash
+
+    git clone https://github.com/mbj4668/pyang.git
+
+OR
+
+.. code-block:: bash
+
+    wget https://github.com/mbj4668/pyang/archive/master.zip
+
+Step 2: Change directory to the downloaded directory and run the setup file.
+
+.. code-block:: bash
+
+    cd pyang
+    python setup.py
+
+2. python-lxml
+--------------
+
+Please follow the below installation link. http://lxml.de/installation.html
+
+
+Parser policy2tosca configuration
+============================
+Parser - POLICY2TOSCA requires the following to be installed.
+
+1. cliff
+--------
+
+Install cliff with the following links.
+::
+- `install <http://docs.openstack.org/developer/cliff/install.html>`
+or
+- `demoapp <http://docs.openstack.org/developer/cliff/demoapp.html>
+
 
diff --git a/docs/parser_docs/intro/intro.rst b/docs/parser_docs/intro/intro.rst
index 195265e..b1fadc5 100644
--- a/docs/parser_docs/intro/intro.rst
+++ b/docs/parser_docs/intro/intro.rst
@@ -45,8 +45,8 @@ For Release C, Parser offers additional capabilities:
   into heat orchestration template correctly. Policy2Tosca module could be installed seperately
   after user installed OPNFV C release platform.
 
-* Tosca2Heat enhancements which includes a set of feature addons for OpenStack tosca-parser module
-  which is integrated in the OPNFV C release platform.
+* Tosca2Heat enhancements which includes a set of feature addons (such as substitution mapping)
+for OpenStack tosca-parser module which is integrated in the OPNFV C release platform.
 
 * Additional testing support.
 
diff --git a/docs/userguide/featureusage.rst b/docs/userguide/featureusage.rst
index db2557f..c42330c 100644
--- a/docs/userguide/featureusage.rst
+++ b/docs/userguide/featureusage.rst
@@ -2,10 +2,10 @@
 .. http://creativecommons.org/licenses/by/4.0
 .. (c) <optionally add copywriters name>
 
-Installation
+Parser tosca2heat Installation
 ============================
 
-Please follow the below installation steps to install parser.
+Please follow the below installation steps to install tosca2heat submodule in parser.
 
 Step 1: Clone the parser project.
 
@@ -50,7 +50,7 @@ Step 3: Install the tosca-parser sub project.
   components, and install heat-translator before installing tosca-parser, which is sure to use the
   OPNFV version of tosca-parser and heat-translator other than openstack's components.
 
-Execution
+Parser tosca2heat Execution
 ===========================
 
 Step 1: Change directory to where the tosca yaml files are present, example is
@@ -75,9 +75,9 @@ Example:
     heat-translator --template-file=vRNC.yaml \
         --template-type=tosca --output-file=vRNC_hot.yaml
 
-Notes: heat-translator will call class of ToscaTemplate in tosca-parser firstly to validate and parse input yaml file,
-then tranlate the file into hot file, if you only want to validate or check the input file
-and don't want to translate, please use tosaca-parser as following:
+Notes: heat-translator will call class of ToscaTemplate in tosca-parser firstly to validate and
+parse input yaml file, then tranlate the file into hot file, if you only want to validate or
+check the input file and don't want to translate, please use tosaca-parser as following:
 
 .. code-block:: bash
 
@@ -89,8 +89,96 @@ Example:
 
    tosca-parser --template-file=vRNC.yaml
 
-References
+Parser tosca2heat References
 ===========================
 Refer two upstream components:
  https://github.com/openstack/tosca-parser/blob/master/doc/source/usage.rst
  https://github.com/openstack/heat-translator/blob/master/doc/source/usage.rst
+
+
+
+
+Parser yang2tosca Execution
+============================
+
+Step 1: Change directory to where the scripts are present.
+
+.. code-block:: bash
+
+    cd parser/yang2tosca
+
+Step 2: Copy the YANG file which needs to be converted into TOSCA to
+        current (parser/yang2tosca) folder.
+
+Step 3: Run the python script "parser.py" with the YANG file as an input option.
+
+.. code-block:: bash
+
+    python parser.py -n "YANG filename"
+
+Example:
+
+.. code-block:: bash
+
+    python parser.py -n example.yaml
+
+Step 4: Verify the TOSCA YAMl which file has been created with the same name
+        as the YANG file with a “_tosca” suffix.
+
+.. code-block:: bash
+
+    cat "YANG filename_tosca.yaml"
+
+Example:
+
+.. code-block:: bash
+
+    cat example_tosca.yaml
+
+
+
+
+
+Parser policy2tosca Execution
+============================
+
+Step 1: To see a list of commands available.
+
+.. code-block:: bash
+
+    policy2tosca --help
+
+Step 2: To see help for an individual command, include the command name on the command line
+
+.. code-block:: bash
+
+    policy2tosca help <service>
+
+Step 3: To inject/remove policy types/policy definitions provide the TOSCA file as input to
+policy2tosca command line.
+
+.. code-block:: bash
+
+    policy2tosca <service> [arguments]
+
+Example:
+
+.. code-block:: bash
+
+    policy2tosca add-definition --policy_name rule2 --policy_type  tosca.policies.Placement.Geolocation
+--description "test description" --properties region:us-north-1,region:us-north-2,min_inst:2 --targets
+VNF2,VNF4 --metadata "map of strings" --triggers "1,2,3,4" --source example.yaml
+
+
+Step 4: Verify the TOSCA YAMl updated with the injection/removal executed.
+
+.. code-block:: bash
+
+    cat "<source tosca file>"
+
+Example:
+
+.. code-block:: bash
+
+    cat example_tosca.yaml
+
diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst
index 9174daa..938f9c6 100644
--- a/docs/userguide/index.rst
+++ b/docs/userguide/index.rst
@@ -7,14 +7,14 @@
 Parser User Guide
 =================
 Parser is an open source project and licensed under Apache 2. Parser will help
-to provide a tooling mechanism, by parsing Telecom operators VNF descriptors
-(YANG templates) into TOSCA templates and then further translate TOSCA templates
-into certain common templates, which could be used in IaaS orchestration projects
-like OpenStack Heat(the template file is HOT, which stands for Heat Orchestrator
-Template), this document is about simple TOSCA to HOT, and the example is a vRNC
-(virtual Radio Network Controller) definition with format translated from simple
-TOSCA(parser's input file format) to HOT(parser's output file format), which can
-be deployed by heat directly.
+to provide a tooling mechanism, by parsing and then further translating Telecom
+operators deployment descriptors into certain common templates, which could be
+used in IaaS orchestration projects like OpenStack Heat(the template file is HOT,
+which stands for Heat Orchestrator Template).
+
+This document contains installation guide , execution guide as well as testing guide
+for Parser's three submodules: tosca2heat, yang2tosca and policy2tosca.
+
 
 Contents:
 
diff --git a/docs/userguide/testusage.rst b/docs/userguide/testusage.rst
index 35dacae..47f37f1 100644
--- a/docs/userguide/testusage.rst
+++ b/docs/userguide/testusage.rst
@@ -2,7 +2,7 @@
 .. http://creativecommons.org/licenses/by/4.0
 .. (c) <optionally add copywriters name>
 
-Test use tox
+Parser tosca2heat test usage
 ===========================
 1. run tox in tosca-parser sub project