JIRA:PARSER-1 -docs for yang2tosca patch set-3

Signed-off-by: shiva-charan.m-s <shiva-charan.m-s@hp.com>

diff --git a/docs/yang2tosca/README.rst b/docs/yang2tosca/README.rst
new file mode 100644 (file)
index 0000000..0a3b419
--- /dev/null
+++ b/docs/yang2tosca/README.rst
@@ -0,0 +1,66 @@
+=========================\r
+Parser YANG2TOSCA\r
+========================\r
+\r
+Overview\r
+===========================\r
+\r
+Parser is an open source project and licensed under Apache 2. Parser will help\r
+to provide a tooling mechanism, by parsing Telecom operators’ VNF descriptors\r
+(YANG templates) into TOSCA templates and then further translate TOSCA\r
+templates into certain common templates, which could be used in IaaS orchestration\r
+projects like OpenStack Heat.\r
+\r
+Prerequisites\r
+==========================\r
+\r
+Parser requires the following to be installed.\r
+\r
+1. PYANG\r
+-----------------\r
+\r
+Please follow the below installation steps.\r
+\r
+Step 1: Clone pyang tool or download the zip file from the following link.\r
+                git clone https://github.com/mbj4668/pyang.git\r
+                                or\r
+                wget https://github.com/mbj4668/pyang/archive/master.zip\r
+\r
+Step 2: Change directory to the downloaded directory and run the setup file.\r
+                cd pyang\r
+                python setup.py\r
+\r
+2. python-lxml\r
+--------------------\r
+\r
+Please follow the below installation link.\r
+        http://lxml.de/installation.html\r
+\r
+\r
+Installation\r
+============================\r
+\r
+Please follow the below installation steps to install parser.\r
+\r
+Step 1: Clone the parser project.\r
+        git clone https://gerrit.opnfv.org/gerrit/parser\r
+\r
+Execution\r
+===========================\r
+\r
+Step 1: Change directory to where the scripts are present.\r
+        cd parser/yang2tosca\r
+\r
+Step 2: Copy the YANG file which needs to be converted into TOSCA to\r
+        current (parser/yang2tosca) folder.\r
+\r
+Step 3: Run the python script "parser.py" with the YANG file as an input option.\r
+                python parser.py -n "YANG filename"\r
+        Example:\r
+                python parser.py -n example.yaml\r
+\r
+Step 4: Verify the TOSCA YAMl which file has been created with the same name\r
+        as the YANG file with a “_tosca” suffix.\r
+                cat "YANG filename_tosca.yaml"\r
+        Example:\r
+                cat example_tosca.yaml\r

diff --git a/docs/yang2tosca/index.rst b/docs/yang2tosca/index.rst
new file mode 100644 (file)
index 0000000..47c1b03
--- /dev/null
+++ b/docs/yang2tosca/index.rst
@@ -0,0 +1,16 @@
+****************\r
+YANG to TOSCA Documents\r
+****************\r
+\r
+This is the directory to store documents regarding YANG to TOSCA translation.\r
+\r
+The "README" document demonstrates parsing Telecom operators’ VNF descriptors (YANG templates)\r
+into TOSCA templates and then further translate TOSCA templates into certain common templates,\r
+which could be used in IaaS orchestration projects like OpenStack Heat.\r
+\r
+See also https://wiki.opnfv.org/parser .\r
+\r
+.. toctree::\r
+   :maxdepth: 2\r
+\r
+   README.rst\r