diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/how-to-use-docs/documentation-example.rst | 7 | ||||
| -rw-r--r-- | docs/qtip/index.rst | 32 | ||||
| -rw-r--r-- | docs/qtip/opnfv_qtip_tc001.rst | 0 | ||||
| -rw-r--r-- | docs/qtip/opnfv_qtip_tc002.rst | 0 | ||||
| -rw-r--r-- | docs/qtip/opnfv_qtip_tc003.rst | 0 | ||||
| -rw-r--r-- | docs/templates/index.rst | 30 | ||||
| -rw-r--r-- | docs/templates/testcase_description_v2_template.rst | 47 | ||||
| -rw-r--r-- | docs/user_guides/framework/index.rst | 1 | ||||
| -rw-r--r-- | docs/user_guides/framework/installation.rst | 1 |
9 files changed, 115 insertions, 3 deletions
diff --git a/docs/how-to-use-docs/documentation-example.rst b/docs/how-to-use-docs/documentation-example.rst index afcf7581..89b95075 100644 --- a/docs/how-to-use-docs/documentation-example.rst +++ b/docs/how-to-use-docs/documentation-example.rst @@ -1,5 +1,5 @@ .. two dots create a comment. please leave this logo at the top of each of your rst files. -.. image:: ../etc/opnfv-logo.png +.. image:: ../etc/opnfv-logo.png :height: 40 :width: 200 :alt: OPNFV @@ -21,7 +21,8 @@ this is the directory structure of the docs/ directory that can be found in the ./how-to-use-docs/documentation-example.rst ./how-to-use-docs/index.rst -To create your own documentation, Create any number of directories (depending on your need) and place in each of them an index.rst. +To create your own documentation, Create any number of directories (depending on your need) +and place in each of them an index.rst. This index file must refence your other rst files. * Here is an example index.rst @@ -59,7 +60,7 @@ For verify jobs a link to the documentation will show up as a comment in gerrit * Merge jobs -Once you are happy with the look of your documentation you can submit the patchset the merge job will +Once you are happy with the look of your documentation you can submit the patchset the merge job will copy the output of each documentation directory to http://artifacts.opnfv.org/$project/docs/$name_of_your_folder/index.html Here are some quick examples of how to use rst markup diff --git a/docs/qtip/index.rst b/docs/qtip/index.rst new file mode 100644 index 00000000..a8cb43e0 --- /dev/null +++ b/docs/qtip/index.rst @@ -0,0 +1,32 @@ +.. OPNFV Release Engineering documentation, created by + sphinx-quickstart on Tue Jun 9 19:12:31 2015. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +.. image:: ../etc/opnfv-logo.png + :height: 40 + :width: 200 + :alt: OPNFV + :align: left + +Example Documentation table of contents +======================================= + +Contents: + +.. toctree:: + :numbered: + :maxdepth: 4 + + opnfv_qtip_tc001.rst + opnfv_qtip_tc002.rst + opnfv_qtip_tc003.rst + +Indices and tables +================== + +* :ref:`search` + +Revision: _sha1_ + +Build date: |today| diff --git a/docs/qtip/opnfv_qtip_tc001.rst b/docs/qtip/opnfv_qtip_tc001.rst new file mode 100644 index 00000000..e69de29b --- /dev/null +++ b/docs/qtip/opnfv_qtip_tc001.rst diff --git a/docs/qtip/opnfv_qtip_tc002.rst b/docs/qtip/opnfv_qtip_tc002.rst new file mode 100644 index 00000000..e69de29b --- /dev/null +++ b/docs/qtip/opnfv_qtip_tc002.rst diff --git a/docs/qtip/opnfv_qtip_tc003.rst b/docs/qtip/opnfv_qtip_tc003.rst new file mode 100644 index 00000000..e69de29b --- /dev/null +++ b/docs/qtip/opnfv_qtip_tc003.rst diff --git a/docs/templates/index.rst b/docs/templates/index.rst new file mode 100644 index 00000000..c893df6f --- /dev/null +++ b/docs/templates/index.rst @@ -0,0 +1,30 @@ +.. OPNFV Release Engineering documentation, created by + sphinx-quickstart on Tue Jun 9 19:12:31 2015. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +.. image:: ../etc/opnfv-logo.png + :height: 40 + :width: 200 + :alt: OPNFV + :align: left + +Example Documentation table of contents +======================================= + +Contents: + +.. toctree:: + :numbered: + :maxdepth: 4 + + testcase_description_v2_template.rst + +Indices and tables +================== + +* :ref:`search` + +Revision: _sha1_ + +Build date: |today| diff --git a/docs/templates/testcase_description_v2_template.rst b/docs/templates/testcase_description_v2_template.rst new file mode 100644 index 00000000..d68509f8 --- /dev/null +++ b/docs/templates/testcase_description_v2_template.rst @@ -0,0 +1,47 @@ +.. Template to be used for test case descriptions in QTIP Project. + Write one .rst per test case. + Borrowed Heavily from Yardstick + Upload the .rst for the test case in /docs/ directory. + Review in Gerrit. + +************************************* +QTIP Test Case Description TCXXX +************************************* + ++-----------------------------------------------------------------------------+ +|test case slogan e.g. Network throughput | ++==============+==============================================================+ +|test case id | e.g. qtip_throughput | ++--------------+--------------------------------------------------------------+ +|metric | what will be measured, e.g. latency | ++--------------+--------------------------------------------------------------+ +|test purpose | describe what is the purpose of the test case | ++--------------+--------------------------------------------------------------+ +|configuration | what .yaml file to use, state SLA if applicable, state | +| | test duration, list and describe the scenario options used in| +| | this TC and also list the options using default values. | ++--------------+--------------------------------------------------------------+ +|test tool | e.g. ping | ++--------------+--------------------------------------------------------------+ +|references | e.g. RFCxxx, ETSI-NFVyyy | ++--------------+--------------------------------------------------------------+ +|applicability | describe variations of the test case which can be | +| | performend, e.g. run the test for different packet sizes | ++--------------+--------------------------------------------------------------+ +|pre-test | describe configuration in the tool(s) used to perform | +|conditions | the measurements (e.g. fio, pktgen), POD-specific | +| | configuration required to enable running the test | ++--------------+------+----------------------------------+--------------------+ +|test sequence | step | description | result | +| +------+----------------------------------+--------------------+ +| | 1 | use this to describe tests that | what happens in | +| | | require several steps e.g. | this step | +| | | step 1 collect logs | e.g. logs collected| +| +------+----------------------------------+--------------------+ +| | 2 | remove interface | interface down | +| +------+----------------------------------+--------------------+ +| | N | what is done in step N | what happens | ++--------------+------+----------------------------------+--------------------+ +|test verdict | expected behavior, or SLA, pass/fail criteria | ++--------------+--------------------------------------------------------------+ + diff --git a/docs/user_guides/framework/index.rst b/docs/user_guides/framework/index.rst new file mode 100644 index 00000000..b4817d1b --- /dev/null +++ b/docs/user_guides/framework/index.rst @@ -0,0 +1 @@ +.. populate before the deadline diff --git a/docs/user_guides/framework/installation.rst b/docs/user_guides/framework/installation.rst new file mode 100644 index 00000000..ebe23471 --- /dev/null +++ b/docs/user_guides/framework/installation.rst @@ -0,0 +1 @@ +.. Populate this before the deadline |