From a3fe4f09423b8412b565ffb9c7d39a7088b000ed Mon Sep 17 00:00:00 2001 From: Michele Carignani Date: Mon, 13 May 2019 23:23:32 +0200 Subject: [PATCH] Documentation for the doc2tosca tool --- src/templates/doc2tosca-details.html | 39 ++++++++++++++++++++++++---- src/templates/doc2tosca-details.md | 21 +++++++++++++++ src/templates/home.html | 7 +++-- 3 files changed, 60 insertions(+), 7 deletions(-) create mode 100644 src/templates/doc2tosca-details.md diff --git a/src/templates/doc2tosca-details.html b/src/templates/doc2tosca-details.html index 7b4c229..9a0a5e8 100644 --- a/src/templates/doc2tosca-details.html +++ b/src/templates/doc2tosca-details.html @@ -25,18 +25,47 @@

doc2tosca details

+Home
v {{ VERSION }}
-

-The tools available on this page are provided with NO GUARANTEES and shall be used ONLY for validation of ETSI Specifications. -
-For any inquiry, contact ETSI CTI

+
+ +

Overview +

+ +

The tool works as follows:

+ +

Step 1: In the uploaded Document it searches for headings equal to:

+ +

Step 2: For each of the section after the heading (and until the next heading is found), the tool searches for tables with the following properties:

+ + +

Step 3: The three sets of generated definitions are written to files named:

+ + + +

Step 4: The files are archived in a zip file named tosca_defs.zip which is served as a response.

+

+The tools available on this page are provided with NO GUARANTEES and shall be used ONLY for validation of ETSI Specifications. +
+For any inquiry, contact ETSI CTI

Copyright © ETSI 2019. All rights reserved.
- \ No newline at end of file + diff --git a/src/templates/doc2tosca-details.md b/src/templates/doc2tosca-details.md new file mode 100644 index 0000000..080cf8a --- /dev/null +++ b/src/templates/doc2tosca-details.md @@ -0,0 +1,21 @@ +The tool works as follows: + +Step 1: In the uploaded Document it searches for headings equal to: + +* `6\tVNFD TOSCA model` +* `7\tNSD TOSCA model` +* `8\tPNFD TOSCA model`, + +Step 2: For each of the section after the heading (and until the next heading is found), the tool searches for tables with the following properties: + +* It contains only one cell (i.e. one row and one column) and +* the content matches the regular expression `^tosca\.[a-zA-Z\.:0-9\s]*$`, i.e. the text starts with `tosca.` and contains letters, numbers, `:` or white space. + +Step 3: The three sets of generated definitions are written to files named: + +* `generated_etsi_nfv_sol001_vnfd_types.yaml` +* `generated_etsi_nfv_sol001_nsd_types.yaml` +* `generated_etsi_nfv_sol001_pnfd_types.yaml` + +Step 4: The files are archived in a zip file named `tosca_defs.zip` which is served as a response. + diff --git a/src/templates/home.html b/src/templates/home.html index bf671b5..c729da5 100644 --- a/src/templates/home.html +++ b/src/templates/home.html @@ -29,7 +29,10 @@

The tools available on this page are provided with NO GUARANTEES and shall be used ONLY for validation of ETSI Specifications.
-For any inquiry, contact ETSI CTI

+
+To report bugs, questions or feature request, please use the the issue tracker at ETSI Forge and select "TOSCA tools" as component. +
+For any other inquiry, contact ETSI CTI

@@ -88,4 +91,4 @@ For any inquiry, contact ETSI CTI

- \ No newline at end of file + -- GitLab