summaryrefslogtreecommitdiffstats
path: root/docs/index.rst
diff options
context:
space:
mode:
authorLovett, Trevor <trevor.lovett@att.com>2019-02-15 18:17:14 -0600
committerLovett, Trevor <trevor.lovett@att.com>2019-02-16 08:47:41 -0600
commitbcbac1a1498b4f064fba575f7cbe8cb9b3663cd8 (patch)
tree8a185fa51017e0788162dec8ffa5d9d9d7d697cc /docs/index.rst
parent023d74cc2d436659398743c412a602c6c1777fcb (diff)
[VVP] Doc for GUI, Docker, and Deprecation
Revising documentation to reflect the deprecation of the VVP web application as well as adding documentation for the new additions such as: * Alternate report options * Native GUI tool * Docker execution Change-Id: Ia1b1e99e7d5fb657286efb281049e4550a80d1b6 Issue-ID: VVP-137 Signed-off-by: Lovett, Trevor (tl2972) <tl2972@att.com>
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst32
1 files changed, 19 insertions, 13 deletions
diff --git a/docs/index.rst b/docs/index.rst
index e139e9d..906a352 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,26 +1,32 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-.. Copyright 2017 AT&T Intellectual Property. All rights reserved.
+.. Copyright 2019 AT&T Intellectual Property. All rights reserved.
VVP Documentation
-====================
+=================
-The project is to develop a validation program to provide assurance of
-VNF interoperability with ONAP. Obtaining a validation shall be a
-self-service activity and should be against a reference release of
-ONAP for use by the VNF provider & any other validation authority.
+The VNF Validation Platform (VVP) is an application to validate that `OpenStack
+Heat Templates <https://wiki.openstack.org/wiki/Heat>`__ comply with the
+ONAP requirements and guidelines documented in the :doc:`Heat section <../../../../../submodules/vnfrqts/requirements.git/docs/Chapter5/Heat/index>` of
+the ONAP's :doc:`VNF Requirements and Guidelines documentation <../../../../../guides/onap-provider/index>`.
+Adherence to these guidelines ensures that a VNF can be successfully
+onboarded, modeled, instantiated, and orchestrated by ONAP to the fullest
+extent possible.
+
+VVP is a utility written in Python that can be executed via a
+:doc:`command-line script <validation-scripts>`,
+:ref:`Docker container <vvp-docker-execution>`, or a
+native :doc:`Desktop GUI application <humaninterfaces>` to analyze and report
+on the compliance of a given set of Heat templates to the ONAP requirements.
+
+This guide will provide the user with instructions on how to acquire,
+setup, and execute the validations.
.. toctree::
:maxdepth: 1
+ installation.rst
validation-scripts.rst
- administration.rst
- architecture.rst
- configuration.rst
- delivery.rst
humaninterfaces.rst
- installation.rst
- logging.rst
- offeredapis.rst
release-notes.rst