diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/plugfest/2016.05/test_plan/INFO | 13 | ||||
| -rw-r--r-- | docs/plugfest/2016.05/test_plan/application/testcases.rst | 18 | ||||
| -rw-r--r-- | docs/plugfest/2016.05/test_plan/deployment/testcase1.rst | 39 | ||||
| -rw-r--r-- | docs/plugfest/2016.05/test_plan/deployment/testcase2.rst | 40 | ||||
| -rw-r--r-- | docs/plugfest/2016.05/test_plan/deployment/testcases.rst | 22 | ||||
| -rw-r--r-- | docs/plugfest/2016.05/test_plan/index.rst | 20 | ||||
| -rw-r--r-- | docs/plugfest/2016.05/test_plan/integration/testcases.rst | 20 | ||||
| -rw-r--r-- | docs/plugfest/2016.05/test_plan/preface.rst | 15 | ||||
| -rw-r--r-- | docs/plugfest/2016.05/test_plan/setup/setup.rst | 21 | ||||
| -rw-r--r-- | docs/plugfest/2016.05/test_plan/setup/testframeworkconfig.rst | 10 | ||||
| -rw-r--r-- | docs/plugfest/2016.05/test_plan/templates/template.rst | 38 | ||||
| -rw-r--r-- | docs/userguide/01-introduction.rst | 26 | ||||
| -rw-r--r-- | docs/userguide/02-certification_criteria.rst | 3 | ||||
| -rw-r--r-- | docs/userguide/03-certification_progress.rst | 3 | ||||
| -rw-r--r-- | docs/userguide/index.rst | 16 |
15 files changed, 0 insertions, 304 deletions
diff --git a/docs/plugfest/2016.05/test_plan/INFO b/docs/plugfest/2016.05/test_plan/INFO deleted file mode 100644 index de5c4556..00000000 --- a/docs/plugfest/2016.05/test_plan/INFO +++ /dev/null @@ -1,13 +0,0 @@ -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 deleted file mode 100644 index bb1bba76..00000000 --- a/docs/plugfest/2016.05/test_plan/application/testcases.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. 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 diff --git a/docs/plugfest/2016.05/test_plan/deployment/testcase1.rst b/docs/plugfest/2016.05/test_plan/deployment/testcase1.rst deleted file mode 100644 index f583729a..00000000 --- a/docs/plugfest/2016.05/test_plan/deployment/testcase1.rst +++ /dev/null @@ -1,39 +0,0 @@ -.. 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 deleted file mode 100644 index 579bbe7b..00000000 --- a/docs/plugfest/2016.05/test_plan/deployment/testcase2.rst +++ /dev/null @@ -1,40 +0,0 @@ -.. 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 deleted file mode 100644 index bb8dc9d1..00000000 --- a/docs/plugfest/2016.05/test_plan/deployment/testcases.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 - -============================== -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 deleted file mode 100644 index e4bf5e91..00000000 --- a/docs/plugfest/2016.05/test_plan/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 - -************************** -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 - ./templates/template.rst - diff --git a/docs/plugfest/2016.05/test_plan/integration/testcases.rst b/docs/plugfest/2016.05/test_plan/integration/testcases.rst deleted file mode 100644 index c7211f96..00000000 --- a/docs/plugfest/2016.05/test_plan/integration/testcases.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 - -=============================== -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 diff --git a/docs/plugfest/2016.05/test_plan/preface.rst b/docs/plugfest/2016.05/test_plan/preface.rst deleted file mode 100644 index fab3d7f9..00000000 --- a/docs/plugfest/2016.05/test_plan/preface.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. 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 deleted file mode 100644 index c52af2cc..00000000 --- a/docs/plugfest/2016.05/test_plan/setup/setup.rst +++ /dev/null @@ -1,21 +0,0 @@ -.. 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 deleted file mode 100644 index e958b42c..00000000 --- a/docs/plugfest/2016.05/test_plan/setup/testframeworkconfig.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. 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 deleted file mode 100644 index 6c655cca..00000000 --- a/docs/plugfest/2016.05/test_plan/templates/template.rst +++ /dev/null @@ -1,38 +0,0 @@ -.. 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.” - diff --git a/docs/userguide/01-introduction.rst b/docs/userguide/01-introduction.rst deleted file mode 100644 index dbe33d5d..00000000 --- a/docs/userguide/01-introduction.rst +++ /dev/null @@ -1,26 +0,0 @@ -====================== -Dovetail Introduction -====================== - -**Welcome to Dovetail's documentation !** - -.. _Dovetail: https://wiki.opnfv.org/dovetail - -Dovetail_ is an OPNFV Project. - -This project intends to define and provide a set of OPNFV related validation -criteria that will provide input for the evaluation of the use of OPNFV trademarks. -The dovetail project will be executed with the guidance and oversight of the Compliance -and Certification committee and work to secure the goals of the C&C committee for each release. - -This project intends to incrementally define qualification criteria -that establish the foundations of how we are able to measure the ability -to utilize the OPNFV platform, how the platform itself should behave, -and how applications may be deployed on the platform. - -Contact Dovetail -=================== - -Feedback? `Contact us`_ - -.. _Contact us: opnfv-users@lists.opnfv.org diff --git a/docs/userguide/02-certification_criteria.rst b/docs/userguide/02-certification_criteria.rst deleted file mode 100644 index 7665f9a0..00000000 --- a/docs/userguide/02-certification_criteria.rst +++ /dev/null @@ -1,3 +0,0 @@ -================== -Dovetail Criteria -================== diff --git a/docs/userguide/03-certification_progress.rst b/docs/userguide/03-certification_progress.rst deleted file mode 100644 index 6ee02012..00000000 --- a/docs/userguide/03-certification_progress.rst +++ /dev/null @@ -1,3 +0,0 @@ -================== -Dovetail Progress -================== diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst deleted file mode 100644 index 03246e7b..00000000 --- a/docs/userguide/index.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 - -************************** -Dovetail - user guide -************************** - -.. 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 - - ./01-introduction.rst - ./02-certification_criteria.rst - ./03-certification_progress.rst |