From d576c5d1783593dc3943ca1a1278c8f6c911736c Mon Sep 17 00:00:00 2001 From: MatthewLi Date: Mon, 25 Jan 2016 02:44:55 -0500 Subject: update parser document JIRA: PARSER-14 document format has been updated, this patch is to improve the document in parser project to satisfy the requirement of sphinx. Change-Id: I629fa84a1b0333e9b59c24cdf7444733f7b35582 Signed-off-by: MatthewLi (cherry picked from commit f763149f87564d6dc4e0a605dbe5df720ffe4f9a) --- docs/yang2tosca/README.rst | 66 ---------------------------------------------- docs/yang2tosca/index.rst | 16 ----------- 2 files changed, 82 deletions(-) delete mode 100644 docs/yang2tosca/README.rst delete mode 100644 docs/yang2tosca/index.rst (limited to 'docs/yang2tosca') diff --git a/docs/yang2tosca/README.rst b/docs/yang2tosca/README.rst deleted file mode 100644 index 0a3b419..0000000 --- a/docs/yang2tosca/README.rst +++ /dev/null @@ -1,66 +0,0 @@ -========================= -Parser YANG2TOSCA -======================== - -Overview -=========================== - -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. - -Prerequisites -========================== - -Parser 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. - git clone https://github.com/mbj4668/pyang.git - or - wget https://github.com/mbj4668/pyang/archive/master.zip - -Step 2: Change directory to the downloaded directory and run the setup file. - cd pyang - python setup.py - -2. python-lxml --------------------- - -Please follow the below installation link. - http://lxml.de/installation.html - - -Installation -============================ - -Please follow the below installation steps to install parser. - -Step 1: Clone the parser project. - git clone https://gerrit.opnfv.org/gerrit/parser - -Execution -=========================== - -Step 1: Change directory to where the scripts are present. - 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. - python parser.py -n "YANG filename" - Example: - 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. - cat "YANG filename_tosca.yaml" - Example: - cat example_tosca.yaml diff --git a/docs/yang2tosca/index.rst b/docs/yang2tosca/index.rst deleted file mode 100644 index 47c1b03..0000000 --- a/docs/yang2tosca/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -**************** -YANG to TOSCA Documents -**************** - -This is the directory to store documents regarding YANG to TOSCA translation. - -The "README" document demonstrates 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. - -See also https://wiki.opnfv.org/parser . - -.. toctree:: - :maxdepth: 2 - - README.rst -- cgit 1.2.3-korg