Update for Danube doc structure

JIRA: VES-1

Change-Id: I4c804f65e485f4d4d539263c6702212015d9c99b
Signed-off-by: Aimee Ukasick <aimeeu.opensource@gmail.com>

diff --git a/docs/design/featureconfig_link.rst b/docs/design/featureconfig_link.rst
deleted file mode 100644 (file)
index 6af66f7..0000000
--- a/docs/design/featureconfig_link.rst
+++ /dev/null
@@ -1,2 +0,0 @@
-.. include::
-   ../installationprocedure/feature.configuration.rst

diff --git a/docs/design/featureusage_link.rst b/docs/design/featureusage_link.rst
deleted file mode 100644 (file)
index c3ac10b..0000000
--- a/docs/design/featureusage_link.rst
+++ /dev/null
@@ -1,2 +0,0 @@
-.. include::
-   ../userguide/feature.usage.rst

diff --git a/docs/design/index.rst b/docs/design/index.rst
deleted file mode 100644 (file)
index 982f2a6..0000000
--- a/docs/design/index.rst
+++ /dev/null
@@ -1,20 +0,0 @@
-.. This work is licensed under a
-.. Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. (c) 2015-2017 AT&T Intellectual Property, Inc
-
-********************
-OPNFV Copper Project
-********************
-
-.. toctree::
-   :numbered:
-   :maxdepth: 4
-
-   introduction.rst
-   releasenotes_link.rst
-   definitions.rst
-   usecases.rst
-   featureconfig_link.rst
-   postinstall_link.rst
-   featureusage_link.rst

diff --git a/docs/design/introduction.rst b/docs/design/introduction.rst
deleted file mode 100644 (file)
index 9c5e76c..0000000
--- a/docs/design/introduction.rst
+++ /dev/null
@@ -1,22 +0,0 @@
-.. This work is licensed under a
-.. Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. (c) 2015-2017 AT&T Intellectual Property, Inc
-
-Introduction
-============
-
-..
- This work is licensed under a Creative Commons Attribution 4.0 Unported License.
-
- http://creativecommons.org/licenses/by/4.0
-
-.. NOTE::
-   This is the working documentation for the VNF Event Stream (VES) project.
-
-The `OPNFV VES <https://wiki.opnfv.org/display/ves>`_ project aims to develop OPNFV platform support for VNF event streams, in a common model and format intended for use by NFV Service Providers (SPs), e.g. in managing VNF health and lifecycle. The project’s goal is to enable a significant reduction in the effort to develop and integrate VNF telemetry-related data into automated VNF management systems, by promoting convergence toward a common event stream format and collection system.
-
-The documentation provided here focuses on the specific features supported in the Danube release.
-
-
-

diff --git a/docs/design/postinstall_link.rst b/docs/design/postinstall_link.rst
deleted file mode 100644 (file)
index ca8d99c..0000000
--- a/docs/design/postinstall_link.rst
+++ /dev/null
@@ -1,2 +0,0 @@
-.. include::
-   ../installationprocedure/installation.instruction.rst

diff --git a/docs/design/releasenotes_link.rst b/docs/design/releasenotes_link.rst
deleted file mode 100644 (file)
index 6ee81a3..0000000
--- a/docs/design/releasenotes_link.rst
+++ /dev/null
@@ -1,2 +0,0 @@
-.. include::
-   ../releasenotes/release.notes.rst

diff --git a/docs/design/usecases.rst b/docs/design/usecases.rst
deleted file mode 100644 (file)
index 5df656c..0000000
--- a/docs/design/usecases.rst
+++ /dev/null
@@ -1,16 +0,0 @@
-.. This work is licensed under a
-.. Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. (c) 2015-2017 AT&T Intellectual Property, Inc
-
-Use Cases
-=========
-
-Implemented in Current Release
-------------------------------
-
-VES Hello World Demo
-....................
-
-Information on and links to the VES Hello World demo can be found on the `VES Demo page <https://wiki.opnfv.org/display/ves/vHello_VES+Demo>`_.
-

diff --git a/docs/development/design/architecture.rst b/docs/development/design/architecture.rst
new file mode 100644 (file)
index 0000000..0116d1d
--- /dev/null
+++ b/docs/development/design/architecture.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) 2015-2017 AT&T Intellectual Property, Inc
+
+=============================
+OPNFV VES Danube Architecture
+=============================
+
+.. contents::
+   :depth: 3
+   :local:
+
+Please see the OPNFV VES `wiki <https://wiki.opnfv.org/display/ves>`_
+for an architectural overview.

diff --git a/docs/design/definitions.rst b/docs/development/design/definitions.rst
similarity index 100%
rename from docs/design/definitions.rst
rename to docs/development/design/definitions.rst

diff --git a/docs/development/design/index.rst b/docs/development/design/index.rst
new file mode 100644 (file)
index 0000000..fc1fec5
--- /dev/null
+++ b/docs/development/design/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) 2015-2017 AT&T Intellectual Property, Inc
+
+=======================
+OPNFV VES Danube Design
+=======================
+
+.. toctree::
+   :maxdepth: 1
+
+   definitions
+   architecture
+

diff --git a/docs/development/overview/index.rst b/docs/development/overview/index.rst
new file mode 100644 (file)
index 0000000..cc1c5ac
--- /dev/null
+++ b/docs/development/overview/index.rst
@@ -0,0 +1,13 @@
+.. This work is licensed under a
+.. Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2015-2017 AT&T Intellectual Property, Inc
+
+=========================
+OPNFV VES Danube Overview
+=========================
+
+.. toctree::
+   :maxdepth: 1
+
+   overview

diff --git a/docs/development/overview/overview.rst b/docs/development/overview/overview.rst
new file mode 100644 (file)
index 0000000..3d7673a
--- /dev/null
+++ b/docs/development/overview/overview.rst
@@ -0,0 +1,25 @@
+.. This work is licensed under a
+.. Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2015-2017 AT&T Intellectual Property, Inc
+
+=========================
+OPNFV VES Danube Overview
+=========================
+
+.. contents::
+   :depth: 3
+   :local:
+
+Introduction
+------------
+The `OPNFV VES <https://wiki.opnfv.org/display/ves>`_ project aims to develop OPNFV platform
+support for VNF event streams, in a common model and format intended for use by NFV Service Providers (SPs),
+e.g. in managing VNF health and lifecycle. The project’s goal is to enable a significant reduction
+in the effort to develop and integrate VNF telemetry-related data into automated VNF management systems,
+by promoting convergence toward a common event stream format and collection system.
+
+
+
+
+

diff --git a/docs/development/requirements/index.rst b/docs/development/requirements/index.rst
new file mode 100644 (file)
index 0000000..4d7e7aa
--- /dev/null
+++ b/docs/development/requirements/index.rst
@@ -0,0 +1,13 @@
+.. This work is licensed under a
+.. Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2015-2017 AT&T Intellectual Property, Inc
+
+=============================
+OPNFV VES Danube Requirements
+=============================
+
+.. toctree::
+   :maxdepth: 1
+
+   requirements

diff --git a/docs/development/requirements/requirements.rst b/docs/development/requirements/requirements.rst
new file mode 100644 (file)
index 0000000..1da3c90
--- /dev/null
+++ b/docs/development/requirements/requirements.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) 2015-2017 AT&T Intellectual Property, Inc
+
+=============================
+OPNFV VES Danube Requirements
+=============================
+
+.. contents::
+   :depth: 3
+   :local:
+
+Please see the OPNFV Models `wiki <https://wiki.opnfv.org/display/ves>`_
+for details on VES project's development requirements.

diff --git a/docs/installationprocedure/index.rst b/docs/installationprocedure/index.rst
deleted file mode 100644 (file)
index 2776b88..0000000
--- a/docs/installationprocedure/index.rst
+++ /dev/null
@@ -1,10 +0,0 @@
-***********************************
-OPNFV Copper Installation Procedure
-***********************************
-
-.. toctree::
-   :numbered:
-   :maxdepth: 4
-
-   feature.configuration.rst
-   installation.instruction.rst

diff --git a/docs/installationprocedure/feature.configuration.rst b/docs/release/configguide/featureconfig.rst
similarity index 62%
rename from docs/installationprocedure/feature.configuration.rst
rename to docs/release/configguide/featureconfig.rst
index 9359aaf..8f36f82 100644 (file)
--- a/docs/installationprocedure/feature.configuration.rst
+++ b/docs/release/configguide/featureconfig.rst
@@ -3,30 +3,20 @@
 .. http://creativecommons.org/licenses/by/4.0
 .. (c) 2015-2017 AT&T Intellectual Property, Inc
 
-VES Configuration
-====================
+=======================
+OPNFV VES Configuration
+=======================
 
+.. contents::
+   :depth: 3
+   :local:
 
-Pre-configuration Activities
-----------------------------
-None required.
-
-Hardware Configuration
+Hardware configuration
 ----------------------
-There is no specific hardware configuration required for the VES project.
-
-Feature Configuration
----------------------
-
-OPNFV Installer Support
-.......................
-
 There is currently no OPNFV installer support for the components used by the VES project.
 
-
-Manual Installation
-...................
-
+Feature configuration
+---------------------
 The VES test scripts automatically install VES components. Instructions are included in the following scripts:
 
   * ves/tests/vHello_VES.sh
@@ -34,5 +24,3 @@ The VES test scripts automatically install VES components. Instructions are incl
 Prerequisites to using vHello_VES:
 
   * OPFNV installed via JOID or Apex
-
-

diff --git a/docs/release/configguide/index.rst b/docs/release/configguide/index.rst
new file mode 100644 (file)
index 0000000..2336694
--- /dev/null
+++ b/docs/release/configguide/index.rst
@@ -0,0 +1,14 @@
+.. This work is licensed under a
+.. Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2015-2017 AT&T Intellectual Property, Inc
+
+================================
+OPNFV Models Configuration Guide
+================================
+
+.. toctree::
+   :maxdepth: 1
+
+   featureconfig
+   postinstall

diff --git a/docs/release/configguide/postinstall.rst b/docs/release/configguide/postinstall.rst
new file mode 100644 (file)
index 0000000..7367a5c
--- /dev/null
+++ b/docs/release/configguide/postinstall.rst
@@ -0,0 +1,26 @@
+.. This work is licensed under a
+.. Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2015-2017 AT&T Intellectual Property, Inc
+
+========================================
+OPNFV Models Post Installation Procedure
+========================================
+
+
+
+.. contents::
+   :depth: 3
+   :local:
+
+Automated post installation activities
+--------------------------------------
+None
+
+Models post configuration procedures
+------------------------------------
+None
+
+Platform components validation
+------------------------------
+None

diff --git a/docs/release/installation/index.rst b/docs/release/installation/index.rst
new file mode 100644 (file)
index 0000000..53fd26a
--- /dev/null
+++ b/docs/release/installation/index.rst
@@ -0,0 +1,13 @@
+.. This work is licensed under a
+.. Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2015-2017 AT&T Intellectual Property, Inc
+
+======================
+OPNFV VES Installation
+======================
+
+.. toctree::
+   :maxdepth: 1
+
+   installation.instruction

diff --git a/docs/installationprocedure/installation.instruction.rst b/docs/release/installation/installation.instruction.rst
similarity index 100%
rename from docs/installationprocedure/installation.instruction.rst
rename to docs/release/installation/installation.instruction.rst

diff --git a/docs/release/release-notes/index.rst b/docs/release/release-notes/index.rst
new file mode 100644 (file)
index 0000000..b0639bc
--- /dev/null
+++ b/docs/release/release-notes/index.rst
@@ -0,0 +1,13 @@
+.. This work is licensed under a
+.. Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2015-2017 AT&T Intellectual Property, Inc
+
+=======================
+OPNFV VES Release Notes
+=======================
+
+.. toctree::
+   :maxdepth: 1
+
+   release-notes

diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst
new file mode 100644 (file)
index 0000000..34a3796
--- /dev/null
+++ b/docs/release/release-notes/release-notes.rst
@@ -0,0 +1,33 @@
+.. This work is licensed under a
+.. Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2015-2017 AT&T Intellectual Property, Inc
+
+=======================
+OPNFV VES Release Notes
+=======================
+
+This document provides the release notes for the Danube Release of VES.
+
+.. contents::
+   :depth: 3
+   :local:
+
+
+Version history
+---------------
+
++--------------------+--------------------+--------------------+--------------------+
+| **Date**           | **Ver.**           | **Author**         | **Comment**        |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+| 2017 8 Feb         | 1.0.0              | Bryan Sullivan     |                    |
+|                    |                    | Aimee Ukasick      |                    |
++--------------------+--------------------+--------------------+--------------------+
+
+Summary
+-------
+
+This release includes:
+
+  * Further enhancements of VES test scripts

diff --git a/docs/release/scenarios/scenario.name/index.rst b/docs/release/scenarios/scenario.name/index.rst
new file mode 100644 (file)
index 0000000..d188cb5
--- /dev/null
+++ b/docs/release/scenarios/scenario.name/index.rst
@@ -0,0 +1,14 @@
+.. This work is licensed under a
+.. Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2015-2017 AT&T Intellectual Property, Inc
+
+===================
+OPNFV VES Scenarios
+===================
+
+.. toctree::
+   :maxdepth: 1
+
+   scenario.description
+

diff --git a/docs/release/scenarios/scenario.name/scenario.description.rst b/docs/release/scenarios/scenario.name/scenario.description.rst
new file mode 100644 (file)
index 0000000..005d537
--- /dev/null
+++ b/docs/release/scenarios/scenario.name/scenario.description.rst
@@ -0,0 +1,18 @@
+.. This work is licensed under a
+.. Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2015-2017 AT&T Intellectual Property, Inc
+
+===================
+OPNFV VES Scenarios
+===================
+
+This document provides scenario level details for the Danube release of VES.
+
+.. contents::
+   :depth: 3
+   :local:
+
+Introduction
+------------
+There are no formal scenarios at this time.

diff --git a/docs/userguide/feature.usage.rst b/docs/release/userguide/feature.userguide.rst
similarity index 81%
rename from docs/userguide/feature.usage.rst
rename to docs/release/userguide/feature.userguide.rst
index c82b861..d9fd787 100644 (file)
--- a/docs/userguide/feature.usage.rst
+++ b/docs/release/userguide/feature.userguide.rst
@@ -3,10 +3,16 @@
 .. http://creativecommons.org/licenses/by/4.0
 .. (c) 2015-2017 AT&T Intellectual Property, Inc
 
-VES Capabilities and Usage
-=============================
+====================
+OPNFV VES User Guide
+====================
+
+.. contents::
+   :depth: 3
+   :local:
 
 Current information on the capabilities of the VES project can be found on the VES `wiki <https://wiki.opnfv.org/display/ves>`_.
 
 Examples of test usage can be found on the VES `Demo <https://https://wiki.opnfv.org/display/ves/vHello_VES+Demo>`_ page.
 
+

diff --git a/docs/releasenotes/release.notes.rst b/docs/release/userguide/index.rst
similarity index 56%
rename from docs/releasenotes/release.notes.rst
rename to docs/release/userguide/index.rst
index f3779b0..39def0a 100644 (file)
--- a/docs/releasenotes/release.notes.rst
+++ b/docs/release/userguide/index.rst
@@ -3,16 +3,14 @@
 .. http://creativecommons.org/licenses/by/4.0
 .. (c) 2015-2017 AT&T Intellectual Property, Inc
 
-Release Notes
-=============
+====================
+OPNFV VES User Guide
+====================
 
-VES Danube Release Scope
----------------------------
-
-OPNFV Danube includes:
-
-  * Further enhancements of VES test scripts
+.. toctree::
+   :maxdepth: 1
 
+   feature.userguide
 
 
 

diff --git a/docs/releasenotes/index.rst b/docs/releasenotes/index.rst
deleted file mode 100644 (file)
index a999c8e..0000000
--- a/docs/releasenotes/index.rst
+++ /dev/null
@@ -1,9 +0,0 @@
-**************************
-OPNFV Models Release Notes
-**************************
-
-.. toctree::
-   :numbered:
-   :maxdepth: 4
-
-   release.notes.rst

diff --git a/docs/testing/index.rst b/docs/testing/index.rst
new file mode 100644 (file)
index 0000000..1f5cb52
--- /dev/null
+++ b/docs/testing/index.rst
@@ -0,0 +1,13 @@
+.. This work is licensed under a
+.. Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2015-2017 AT&T Intellectual Property, Inc
+
+=================
+OPNFV VES Testing
+=================
+
+.. toctree::
+   :maxdepth: 1
+
+   usecases.rst

diff --git a/docs/testing/usecases.rst b/docs/testing/usecases.rst
new file mode 100644 (file)
index 0000000..7c8be06
--- /dev/null
+++ b/docs/testing/usecases.rst
@@ -0,0 +1,30 @@
+.. This work is licensed under a
+.. Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2015-2017 AT&T Intellectual Property, Inc
+
+===================
+OPNFV VES Use Cases
+===================
+
+Implemented in Current Release
+------------------------------
+
+VES Hello World
+...............
+
+The VES Hello World demo runs in a multi-node bare metal or virtual install,
+adding VES agents for the hosts (bare metal, VMs) and apps. Data is collected
+by `collectd <https://collectd.org/>`_ and sent in JSON format via HTTP to a the
+VES collector agent.
+
+This use case is a basic TOSCA blueprint-based test using Tacker as the VNFM:
+a single-node simple python web server, connected to two internal networks (private and admin),
+and accessible via a floating IP. This is based upon the OpenStack Tacker project's 'tosca-vnfd-hello-world' blueprint,
+as modified/extended for testing of Tacker-supported features as of OpenStack Newton.
+
+
+Information on and links to the VES Hello World demo can be
+found on the `VES Demo page <https://wiki.opnfv.org/display/ves/vHello_VES+Demo>`_.
+
+

diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst
deleted file mode 100644 (file)
index 6e45330..0000000
--- a/docs/userguide/index.rst
+++ /dev/null
@@ -1,9 +0,0 @@
-***********************
-OPNFV Models User Guide
-***********************
-
-.. toctree::
-   :numbered:
-   :maxdepth: 4
-
-   feature.usage.rst