VVP - Fixing Doc's to be added to readthedocs

Updating the Documentation structure to be included in the readthedocs for the Beijing release.

Change-Id: I91627a726ed3076aeaef0131d186b6d5ad6de597
Issue-ID: VVP-35
Signed-off-by: Bozawglanian, Hagop (hb755d) <hb755d@att.com>

11 files changed, 158 insertions, 37 deletions

diff --git a/.gitreview b/.gitreview
new file mode 100644
index 0000000..73048fb
--- /dev/null
+++ b/.gitreview
@@ -0,0 +1,5 @@
+[gerrit]
+host=gerrit.onap.org
+port=29418
+project=vvp/documentation
+
diff --git a/docs/administration.rst b/docs/administration.rst
index a39aa9b..11e2c7b 100755..100644
--- a/docs/administration.rst
+++ b/docs/administration.rst
@@ -1,15 +1,27 @@
 .. 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.

 

 Administration

---------------

-There is a functionality which part of Django framework to manage all models and tables located on our application's db.

+================

+

+There is a functionality which part of Django framework to manage all

+models and tables located on our application's db.

 The django based containers are: engagement-manager, cms, ci tests

 

 Usually, the admin dashboard url is http(s)://{{domain}}/admin/

-Throght there you will see all models exists in the related application (in the shape of tables) and will be able to create/update/delete there rows.

+Throght there you will see all models exists in the related application

+(in the shape of tables) and will be able to create/update/delete there rows.

+

+The VVP application allow you to login into portal as admin (usually created

+under admin@{{your-domain}}.com). The admin allow you to manage VVP entities,

+update templates and display all availiable engagements and VFs.

+You can reach the screen by clicking the user bubble on top-right

+of the screen, and from the drop-down menu - click the 'Admin' button.

+

+Processes

+-----------

 

 

-The VVP application allow you to login into portal as admin (usually created under admin@{{your-domain}}.com). The admin allow you to manage VVP entities, update templates and display all availiable engagements and VFs.

-You can reach the screen by clicking the user bubble on top-right of the screen, and from the drop-down menu - click the 'Admin' button.

+Actions

+---------

diff --git a/docs/architecture.rst b/docs/architecture.rst
index d1eb514..404fd89 100755..100644
--- a/docs/architecture.rst
+++ b/docs/architecture.rst
@@ -1,17 +1,23 @@
 .. 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.

 

 

 Architecture

-------------

-The architecture of VVP based on micro-services. Each element has dedicated container.

+===============

+

+The architecture of VVP based on micro-services. Each element has

+dedicated container.

 VVP uses rocket and kubernetes to manage the VVP system.

-There is a devkit component which allows you to render and deploy VVP. It's render and deploy the rockets with kuberenetes management (via quay.io).

+There is a devkit component which allows you to render and deploy VVP.

+It's render and deploy the rockets with kuberenetes management (via quay.io).

+

+We store files on Ceph distributed storage system that includes 'RADOS Gateway'

+which allows us to store files in AWS S3 based API (buckets etc..).

 

-We store files on Ceph distributed storage system that includes 'RADOS Gateway' which allows us to store files in AWS S3 based API (buckets etc..).

+Architecture Alignment

+----------------------------

 

-Architecture Alignment:

-+++++++++++++++++++++++

 How does this project fit into the rest of the ONAP Architecture?

 * The VNF Validation Program will utilize the architecture to validate VNFs against it.

 What other ONAP projects does this project depend on?

@@ -20,9 +26,10 @@ How does this align with external standards/specifications?
 * Are there dependencies with other open source projects?

   * OpenStack

 

+Interactions

+-------------------

 

 This is the list of containers part of VVP application:

-+++++++++++++++++++++++++++++++++++++++++++++++++++++++

 * ci-uwsgi - end-to-end flow tests based on Seleniunm

 * cms-nginx - webserver of CMS

 * cms-uwsgi - backend uwsgi server which hosts django application

@@ -39,7 +46,6 @@ This is the list of containers part of VVP application:
 * celery - task queue manager which manage all validation tasks

 

 Repo name:

-++++++++++

 * org.onap.vvp/devkit

 * org.onap.vvp/ansible-ice-bootstrap

 * org.onap.vvp/portal

@@ -53,4 +59,4 @@ Repo name:
 * org.onap.vvp/test-engine

 * org.onap.vvp/validation-scripts

 * org.onap.vvp/documentation

-* org.onap.vvp/image-scanner 
\ No newline at end of file
+* org.onap.vvp/image-scanner

diff --git a/docs/configuration.rst b/docs/configuration.rst
index 30fc54a..ea100b6 100755..100644
--- a/docs/configuration.rst
+++ b/docs/configuration.rst
@@ -1,7 +1,9 @@
 .. 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.

 

 Configuration

--------------

+================

+

 All the configuration is happening on vvp-devkit component.

 There you will define all related fields for each component in a dedicated .yaml file.

diff --git a/docs/delivery.rst b/docs/delivery.rst
index b417dbc..603ca1f 100755..100644
--- a/docs/delivery.rst
+++ b/docs/delivery.rst
@@ -1,6 +1,11 @@
+.. 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.

+

 Delivery

---------

+==========

+

 Describe how functions are packaged into run-time components.

 For some components a block diagram may be useful.

 

-All the project deploy is under ansible files which rendered and deployed in devkit component.
\ No newline at end of file
+All the project deploy is under ansible files which rendered and deployed in devkit component.

diff --git a/docs/humaninterfaces.rst b/docs/humaninterfaces.rst
index 2d478db..34e8349 100755..100644
--- a/docs/humaninterfaces.rst
+++ b/docs/humaninterfaces.rst
@@ -1,4 +1,11 @@
 .. 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.

 

-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.
\ No newline at end of file
+Human Interfaces

+======================

+

+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.

diff --git a/docs/index.rst b/docs/index.rst
index 3773179..5a85c79 100755..100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,18 +1,23 @@
 .. 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.

+

+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.

 

-Platform Component

-==================

-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.

 

 .. toctree::

    :maxdepth: 1

 

+   administration.rst

    architecture.rst

-   offeredapis.rst

-   delivery.rst

-   logging.rst

-   installation.rst

    configuration.rst

-   administration.rst

+   delivery.rst

    humaninterfaces.rst

+   installation.rst

+   logging.rst

+   offeredapis.rst

+   release-notes.rst

diff --git a/docs/installation.rst b/docs/installation.rst
index 6942a9d..8331058 100755..100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -1,6 +1,14 @@
 .. 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.

 

 Installation

-------------

-install happens throgth devkit.
\ No newline at end of file
+==================

+

+Installation happens through the vvp-devkit project.

+

+Environment

+--------------

+

+Steps

+----------

diff --git a/docs/logging.rst b/docs/logging.rst
index 3783a6c..05284ed 100755..100644
--- a/docs/logging.rst
+++ b/docs/logging.rst
@@ -1,6 +1,14 @@
 .. 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.

 

-Logging & Diagnostic Information

+Logging

+==========

+Login into portal/em admin/cms admin

+

+Where to Access Information

 --------------------------------

-Login into portal/em admin/cms admin
\ No newline at end of file
+

+

+Error / Warning Messages

+----------------------------

diff --git a/docs/offeredapis.rst b/docs/offeredapis.rst
index 2b733d5..4e7cc0d 100755..100644
--- a/docs/offeredapis.rst
+++ b/docs/offeredapis.rst
@@ -1,19 +1,20 @@
 .. 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.

 

 

 Offered APIs

-============

-List APIs offered.   One or more of the following examples may be appropriate.

+==============

+

 

 Example Swagger Displayed with swaggerv2doc directive

------------------------------------------------------

+--------------------------------------------------------

 

 .. swaggerv2doc:: https://gerrit.onap.org/r/gitweb?p=vfc/nfvo/lcm.git;a=blob_plain;f=lcm/swagger/vfc.nslcm.swagger.json

 

 

 Example documenting a REST interface with Sphinx httpdomain directive

----------------------------------------------------------------------

+-----------------------------------------------------------------------

 

 .. http:get:: path

 

@@ -21,9 +22,9 @@ Example documenting a REST interface with Sphinx httpdomain directive
 

 

 Word Document Converted to RST using Pandocs

---------------------------------------------

+-----------------------------------------------

 

-.. toctree:: 

+.. toctree::

    :maxdepth: 1

 

    ../../submodules/appc.git/docs/APPC API Guide/APPC API Guide

diff --git a/docs/release-notes.rst b/docs/release-notes.rst
new file mode 100644
index 0000000..f1924ed
--- /dev/null
+++ b/docs/release-notes.rst
@@ -0,0 +1,62 @@
+.. 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.
+
+
+Release Notes
+===============================
+
+.. note::
+   VNF Onboarding is a challenge across the industry because of a lack of a
+   standard form for VNFs.
+   The VVP project was created to provide validation scripts for
+   VNFs to test validity against the ONAP Requirements.
+
+Version: 1.0.0
+---------------
+
+
+:Release Date: 2018-05-24
+
+
+
+**New Features**
+
+    - Initial release of VNF Validation Program (VVP) for Open Network Automation Platform (ONAP)
+
+    - This intitial releases is based on seed documents that came from Open-O
+      and Open ECOMP.
+
+        This release provides a process to allow VNFs to be incubated
+        and validated against the ONAP Heat Requirements.
+
+**Bug Fixes**
+
+    - None
+
+**Known Issues**
+
+    - As of now, the VVP Project has been created to check Validity for
+      VNFs using Heat Orchestration Templates.
+
+    - Only deployable using OOM, will be a standalone toolkit in the future.
+
+    - EWSGI webserver dependencies.
+
+**Security Issues**
+
+    - No known security issues.
+
+**Upgrade Notes**
+
+    - Initial release - none
+
+**Deprecation Notes**
+
+    - Initial release - none
+
+**Other**
+
+===========
+
+End of Release Notes