From 1ec6e546d66b2735ceed2c93c53f8a30798b3071 Mon Sep 17 00:00:00 2001 From: SerenaFeng Date: Thu, 18 Aug 2016 17:07:23 +0800 Subject: complement Parser related userguide JIRA: FUNCTEST-423 Change-Id: Ib52e04a873a2a924102832fe5461ebab2296464d Signed-off-by: SerenaFeng --- docs/userguide/index.rst | 3 ++- docs/userguide/introduction.rst | 11 +++++++++-- docs/userguide/troubleshooting.rst | 2 +- 3 files changed, 12 insertions(+), 4 deletions(-) (limited to 'docs/userguide') diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst index c0c3aa1b..0e13d354 100644 --- a/docs/userguide/index.rst +++ b/docs/userguide/index.rst @@ -405,7 +405,7 @@ The Clearwater architecture is described as follows: parser ^^^^^^ -See parser user guide for details: ** TODO link ** +See parser user guide for details: `[12]`_ .. include:: ./runfunctest.rst @@ -490,6 +490,7 @@ References .. _`[7]`: https://github.com/OpenSCAP/openscap .. _`[9]`: https://git.opnfv.org/cgit/functest/tree/testcases/VIM/OpenStack/CI/libraries/os_defaults.yaml .. _`[11]`: http://robotframework.org/ +.. _`[12]`: http://artifacts.opnfv.org/parser/docs/userguide/index.html OPNFV main site: opnfvmain_. diff --git a/docs/userguide/introduction.rst b/docs/userguide/introduction.rst index ce84a9c4..53b3df4a 100644 --- a/docs/userguide/introduction.rst +++ b/docs/userguide/introduction.rst @@ -135,8 +135,14 @@ Features and VNF (Virtual Network Functions). | | | | It provides a fully functional | | | | | VoIP System | + +---------------+----------------+----------------------------------+ -| | | parser | Service template translation | -| | | | TODO See for details | +| | | parser | Parser is an integration project | +| | | | which aims to provide | +| | | | placement/deployment templates | +| | | | translation for OPNFV platform, | +| | | | including TOSCA -> HOT, POLICY ->| +| | | | TOSCA and YANG -> TOSCA. | +| | | | See `Parser User Guide`_ for | +| | | | details | +-------------+---------------+----------------+----------------------------------+ @@ -208,4 +214,5 @@ section `Executing the functest suites`_ of this document. .. _`ONOSFW User Guide`: http://artifacts.opnfv.org/onosfw/brahmaputra/docs/userguide/index.html .. _`SDNVPN User Guide`: http://artifacts.opnfv.org/sdnvpn/brahmaputra/docs/userguide/featureusage.html .. _`Domino User Guide`: http://artifacts.opnfv.org/domino/docs/userguide/index.html +.. _`Parser User Guide`: http://artifacts.opnfv.org/parser/docs/userguide/index.html .. _`Functest Dashboard`: http://testresults.opnfv.org/kibana_dashboards/ diff --git a/docs/userguide/troubleshooting.rst b/docs/userguide/troubleshooting.rst index c23b0060..0288d295 100644 --- a/docs/userguide/troubleshooting.rst +++ b/docs/userguide/troubleshooting.rst @@ -384,7 +384,7 @@ described in the following table: parser ^^^^^^ -See parser user guide for details: ** TODO link ** +For now log info is the only way to do trouble shooting .. _`OPNFV Functest Developer Guide`: http://artifacts.opnfv.org/functest/docs/devguide/# -- cgit 1.2.3-korg