From 6fecb729f550f4f543739375df8148ab9de38668 Mon Sep 17 00:00:00 2001 From: shangxdy Date: Thu, 18 Aug 2016 21:14:39 +0800 Subject: Update the documents in Release C As a developer; I want anybody who cares of project of parser to know what new features in release C; So i update the distribution documents. JIRA:PRASER-87 Change-Id: I0537ba55fa12daa2975f1b794908bca457cfd9c2 Signed-off-by: shangxdy --- docs/configguide/featureconfig.rst | 18 +++++------------- docs/configguide/index.rst | 15 +++++++++++++++ docs/configguide/installerconfig.rst | 12 +++++++----- docs/configguide/postinstall.rst | 30 ------------------------------ 4 files changed, 27 insertions(+), 48 deletions(-) create mode 100644 docs/configguide/index.rst delete mode 100644 docs/configguide/postinstall.rst (limited to 'docs/configguide') diff --git a/docs/configguide/featureconfig.rst b/docs/configguide/featureconfig.rst index 188ee55..dc4fc50 100644 --- a/docs/configguide/featureconfig.rst +++ b/docs/configguide/featureconfig.rst @@ -4,25 +4,17 @@ Parser configuration ===================== -Add a brief introduction to configure OPNFV with this specific feature including -dependancies on platform components, this description should be at a level that -will apply to any installer providing the pre-requisite components. +Parser can be configured with any installer in current OPNFV, it only depends on +openstack. Pre-configuration activities ---------------------------- -Describe specific pre-configuration activities. This should include ensuring the -right components are installed by the installation tools as required for your -feature to function. Refer to the previous installer configuration chapters, -installations guide and release notes +For parser, there is not specific pre-configuration activities. Hardware configuration ---------------------- -Describe the hardware configuration needed for this specific feature +For parser, there is not hardware configuration needed for any current feature. Feature configuration --------------------- -Describe the procedures to configure your feature on the platform in order -that it is ready to use according to the feature instructions in the platform -user guide. Where applicable you should add content in the postinstall.rst -to validate the feature is configured for use. -(checking components are installed correctly etc...) +For parser, there is not specific configure on openstack. diff --git a/docs/configguide/index.rst b/docs/configguide/index.rst new file mode 100644 index 0000000..03ba4b0 --- /dev/null +++ b/docs/configguide/index.rst @@ -0,0 +1,15 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International +.. License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) OPNFV, Ericsson AB and others. + +========================== +Parser Configuration Guide +========================== + +.. toctree:: + :numbered: + :maxdepth: 2 + +.. include:: featureconfig.rst +.. include:: installerconfig.rst diff --git a/docs/configguide/installerconfig.rst b/docs/configguide/installerconfig.rst index ddc7bea..efe6265 100644 --- a/docs/configguide/installerconfig.rst +++ b/docs/configguide/installerconfig.rst @@ -4,23 +4,25 @@ Parser configuration ===================== -Add a brief introduction to configure OPNFV with this specific installer +Parser can be configured with any installer in current OPNFV. Pre-configuration activities ----------------------------- -Describe specific pre-configuration activities. Refer to Installations guide and release notes +For parser, there is not specific pre-configuration activities. Hardware configuration ----------------------- -Describe the hardware configuration needed for this specific installer +For parser, there is not hardware configuration needed for this specific installer. Jumphost configuration ----------------------- -Describe intial Jumphost configuration (network and software)needed in order to deploy the installer +For parser, there is not intial Jumphost configuration (network and software)needed in order +to deploy any installer. Platform components configuration --------------------------------- -Describe the configuration of each component in the installer +For tosca2heat components(tosca-parser and heat-translator) in parser,there are not specific +configuration of each component in installer. diff --git a/docs/configguide/postinstall.rst b/docs/configguide/postinstall.rst deleted file mode 100644 index 252bff6..0000000 --- a/docs/configguide/postinstall.rst +++ /dev/null @@ -1,30 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) - -Parser post installation procedures -==================================== -Add a brief introduction to the methods of validating the installation -according to this specific installer or feature. - -Automated post installation activities ---------------------------------------- -Describe specific post installation activities performed by the OPNFV -deployment pipeline including testing activities and reports. Refer to -the relevant testing guides, results, and release notes. - -note: this section should be singular and derived from the test projects -once we have one test suite to run for all deploy tools. This is not the -case yet so each deploy tool will need to provide (hopefully very simillar) -documentation of this. - -Parser post configuration procedures -------------------------------------- -Describe any deploy tool or feature specific scripts, tests or procedures -that should be carried out on the deployment post install and configuration -in this section. - -Platform components validation -------------------------------- -Describe any component specific validation procedures necessary for your -deployment tool in this section. -- cgit 1.2.3-korg