project document reorganization

JIRA: DOVETAIL-7

Change-Id: Ic17a05ea15858f6f93f112f26b532339f5904178
Signed-off-by: MatthewLi <matthew.lijun@huawei.com>

11 files changed, 266 insertions, 0 deletions

diff --git a/docs/plugfest/2016.05/test_plan/INFO b/docs/plugfest/2016.05/test_plan/INFO
new file mode 100644
index 00000000..de5c4556
--- /dev/null
+++ b/docs/plugfest/2016.05/test_plan/INFO
@@ -0,0 +1,13 @@
+This directory contains the test plan being developed by the OPNFV Dovetail
+project team for the plugfest test events.  The test plan is broken up into
+files containing its individual sections to allow developers to easily
+collaborate, without causing collisions.
+
+Developer Guidelines
+1. Please check with a project leader before creating a new directory.
+2. The content is ordered by the corresponding inclusions in the index.rst
+   file and associated collation files.
+3. The RST format has been selected to provide a file format that
+   allows the inclusion of figures, pictures, and tables while maintaining
+   clear text contribution for the documents and toolchain support.
+
diff --git a/docs/plugfest/2016.05/test_plan/application/testcases.rst b/docs/plugfest/2016.05/test_plan/application/testcases.rst
new file mode 100644
index 00000000..0e49c5c8
--- /dev/null
+++ b/docs/plugfest/2016.05/test_plan/application/testcases.rst
@@ -0,0 +1,23 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+===============================
+Dovetail integration test cases
+===============================
+
+.. This file includes test cases for VNF application deployment on the OPNFV platform.
+
+.. The setup.rst file organises and imports the relevant RST files in this
+.. directory and includes them in the overall plugfest documentation.
+
+We can add some general text here around the application test cases.
+The test case descriptions should likely be organised as single rst
+files in this directory that are imported below the toctree command below.
+
+.. toctree::
+   :maxdepth: 2
+
+   ./testcase1.rst
+   ./testcase2.rst
+   ./testcase_etc.rst
+
diff --git a/docs/plugfest/2016.05/test_plan/deployment/testcase1.rst b/docs/plugfest/2016.05/test_plan/deployment/testcase1.rst
new file mode 100644
index 00000000..6014bda3
--- /dev/null
+++ b/docs/plugfest/2016.05/test_plan/deployment/testcase1.rst
@@ -0,0 +1,40 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Test case one
+-------------
+
+Purpose
+^^^^^^^
+
+This test case is the first and therefore most important test case.
+As the first you should take care to do all the set-up found in the
+`Plugfest setup and configuration`_ section.
+
+References
+^^^^^^^^^^
+
+Somewhere in `ETSI`_ there is a useful link.
+
+Test Setup
+^^^^^^^^^^
+
+1.  The number 1 is of special relevance to this test case.
+2.  Do not stray to the number 2.
+3.  This step needs to be performed only once.
+
+Method of Procedure
+^^^^^^^^^^^^^^^^^^^
+
+1.  Count to one.
+2.  Stop, if you counted further a retest is required.
+
+Expected Results
+^^^^^^^^^^^^^^^^
+
+1.  You arrived at 1.
+2.  This results is used to indicate the pass/fail status for the test case executor.
+3.  To pass a test case, it all individual metrics would be expected to “pass”.
+
+.. _ETSI: http://www.etsi.org/
+
diff --git a/docs/plugfest/2016.05/test_plan/deployment/testcase2.rst b/docs/plugfest/2016.05/test_plan/deployment/testcase2.rst
new file mode 100644
index 00000000..9c906146
--- /dev/null
+++ b/docs/plugfest/2016.05/test_plan/deployment/testcase2.rst
@@ -0,0 +1,40 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Test case two
+-------------
+
+Purpose
+^^^^^^^
+
+This test case is the second and no one really cares for it.
+If you have it in you please refer to the `Plugfest setup and configuration`_ section,
+it's OK to simply amble on at this stage.  *(It's only the second test case)*
+
+References
+^^^^^^^^^^
+
+Somewhere in `ETSI`_ there may be a useful link.
+
+Test Setup
+^^^^^^^^^^
+
+1.  The number 2 is kind of important.
+2.  Try and get to the number 2.
+3.  It's OK if you only count to 1 we understand.
+
+Method of Procedure
+^^^^^^^^^^^^^^^^^^^
+
+1.  Count to two.
+2.  Stop, if you counted to something else we forgive you.
+
+Expected Results
+^^^^^^^^^^^^^^^^
+
+1.  You arrived at 2.
+2.  This results is used to indicate the pass/fail status for the test case itself.
+3.  To pass a test case, metrics would be expected to “pass” 1 and not stray to 3.
+
+.. _ETSI: http://www.etsi.org/
+
diff --git a/docs/plugfest/2016.05/test_plan/deployment/testcases.rst b/docs/plugfest/2016.05/test_plan/deployment/testcases.rst
new file mode 100644
index 00000000..bb8dc9d1
--- /dev/null
+++ b/docs/plugfest/2016.05/test_plan/deployment/testcases.rst
@@ -0,0 +1,22 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+==============================
+Dovetail deployment test cases
+==============================
+
+.. This file includes the test cases specific to the OPNFV deployment testing.
+
+.. The setup.rst file organises and imports the relevant RST files in this
+.. directory and includes them in the overall plugfest documentation.
+
+We can add some general text here around the deployment test cases.
+The test case descriptions should likely be organised as single rst
+files in this directory that are inported below the toctree command below.
+
+.. toctree::
+   :maxdepth: 2
+
+   ./testcase1.rst
+   ./testcase2.rst
+
diff --git a/docs/plugfest/2016.05/test_plan/index.rst b/docs/plugfest/2016.05/test_plan/index.rst
new file mode 100644
index 00000000..61de3bd5
--- /dev/null
+++ b/docs/plugfest/2016.05/test_plan/index.rst
@@ -0,0 +1,19 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+**************************
+OPNFV Plugfest - test plan
+**************************
+
+.. This index.rst file is used to structure and organise the content in these directories.
+.. The documentation toolchain will create web and pdf versions of the content of this file.
+
+.. toctree::
+   :maxdepth: 2
+
+   ./preface
+   ./setup/setup.rst
+   ./deployment/testcases.rst
+   ./integration/testcases.rst
+   ./application/testcases.rst
+
diff --git a/docs/plugfest/2016.05/test_plan/integration/testcases.rst b/docs/plugfest/2016.05/test_plan/integration/testcases.rst
new file mode 100644
index 00000000..d0f01156
--- /dev/null
+++ b/docs/plugfest/2016.05/test_plan/integration/testcases.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
+
+===============================
+Dovetail integration test cases
+===============================
+
+.. This file includes test cases for testing integration
+.. between the OPNFV platform and network equipment (i.e. SDN Controllers,
+.. Routers, etc.).
+
+.. The setup.rst file organises and imports the relevant RST files in this
+.. directory and includes them in the overall plugfest documentation.
+
+We can add some general text here around the integration test cases.
+The test case descriptions should likely be organised as single rst
+files in this directory that are imported below the toctree command below.
+
+.. toctree::
+   :maxdepth: 2
+
+   ./testcase1.rst
+   ./testcase2.rst
+   ./testcase_etc.rst
+
diff --git a/docs/plugfest/2016.05/test_plan/preface.rst b/docs/plugfest/2016.05/test_plan/preface.rst
new file mode 100644
index 00000000..fab3d7f9
--- /dev/null
+++ b/docs/plugfest/2016.05/test_plan/preface.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
+
+Abstract
+========
+
+Describe in a few sentences the intention of this document,
+how it should be used and the intended audience.
+
+Scope
+=====
+
+Describe in a few sentences the intended scope of the document including
+any limitations and constraints the reader shoudl be aware of when
+reading the document.
diff --git a/docs/plugfest/2016.05/test_plan/setup/setup.rst b/docs/plugfest/2016.05/test_plan/setup/setup.rst
new file mode 100644
index 00000000..c52af2cc
--- /dev/null
+++ b/docs/plugfest/2016.05/test_plan/setup/setup.rst
@@ -0,0 +1,21 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+================================
+Plugfest setup and configuration
+================================
+
+.. This directory includes files and information for the test
+.. equipment, setup, configuration, and other general items that apply
+.. to multiple test cases.
+
+.. The setup.rst file organises and imports the relevant RST files in this
+.. directory and includes them in the overall plugfest documentation.
+
+We can add some general text here introducing the setup and configuration
+before digging into the details of each of the necessary sub chapters.
+
+.. toctree::
+   :maxdepth: 2
+
+   ./testframeworkconfig.rst
diff --git a/docs/plugfest/2016.05/test_plan/setup/testframeworkconfig.rst b/docs/plugfest/2016.05/test_plan/setup/testframeworkconfig.rst
new file mode 100644
index 00000000..e958b42c
--- /dev/null
+++ b/docs/plugfest/2016.05/test_plan/setup/testframeworkconfig.rst
@@ -0,0 +1,10 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+---------------------------------------
+Configuring the dovetail test framework
+---------------------------------------
+
+.. This file should outline how to configure the test framework for DoveTail
+
+Text required to be added here regarding the test framework configuration.
diff --git a/docs/plugfest/2016.05/test_plan/templates/template.rst b/docs/plugfest/2016.05/test_plan/templates/template.rst
new file mode 100644
index 00000000..6c655cca
--- /dev/null
+++ b/docs/plugfest/2016.05/test_plan/templates/template.rst
@@ -0,0 +1,38 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Test case title
+---------------
+
+Purpose
+^^^^^^^
+
+Description of the intended purpose of the test case.
+Purpose may also describe the cause/need of the test case,
+such as, describing a specific high availability failover cause.
+
+References
+^^^^^^^^^^
+
+Pointer to specific reference in standard, architecture, or other documentation.
+
+Test Setup
+^^^^^^^^^^
+
+1.  List of equipment or software specific to this test case.
+2.  List of steps required to prepare the devices / network for testing.
+3.  These steps need to be performed only once.
+
+Method of Procedure
+^^^^^^^^^^^^^^^^^^^
+
+1.  List of steps to perform the actual test case
+2.  These steps might be performed multiple times, if a retest is required.
+
+Expected Results
+^^^^^^^^^^^^^^^^
+
+1.  List of specific results expected from the procedure.
+2.  These results / test metrics are used to indicate the pass/fail status for the test case.
+3.  To pass a test case, it all individual metrics would be expected to “pass.”
+