diff options
| author |   Ana C <ana.cunha@ericsson.com> | 2015-12-11 15:56:08 +0100 |
|---|---|---|
| committer | Ana C <ana.cunha@ericsson.com> | 2015-12-16 12:18:59 +0100 |
| commit | 3f78f83f984553f775f63caaff32dc3c48efff1e (patch) | |
| tree | 32e46ea8ce38fc49ce48c8bc85d875f1d2e79d06 /docs/templates/testcase_description_template.rst | |
| parent | 05c1840c9c4dda154c9c5d00ff3cd23ba202330b (diff) | |
Adapt documentation to latest guidelines
Adapt Yardstick documentation according to the latest guidelines from the
Releng project.
The only change in test case description TC001 and TC002 is to remove logo.
The same for the test case description v2 template.
The previous version of test case description is deleted from repo.
The Yardstick_task_template is edited to keep line lenght 80 char.
This commit also adds index for docs/yardstick and for
docs/user_guides/framework.
The overview for the vTC .rst file has been fixed to enable the .pdf
generation.
Change-Id: Ib6480c3c29ce0f0ee22c9ad717439f6a293ab842
Signed-off-by: Ana C <ana.cunha@ericsson.com>
Diffstat (limited to 'docs/templates/testcase_description_template.rst')
| -rw-r--r-- | docs/templates/testcase_description_template.rst | 94 |
1 files changed, 0 insertions, 94 deletions
diff --git a/docs/templates/testcase_description_template.rst b/docs/templates/testcase_description_template.rst deleted file mode 100644 index 1651d360c..000000000 --- a/docs/templates/testcase_description_template.rst +++ /dev/null @@ -1,94 +0,0 @@ -.. Template to be used for test case descriptions in Yardstick Project. - Write one .rst per test case. - Upload the .rst for the test case in /docs/source/yardstick directory. - Review in Gerrit. - -.. image:: ../etc/opnfv-logo.png - :height: 40 - :width: 200 - :alt: OPNFV - :align: left - -****************** -Test Case <slogan> -****************** - -.. contents:: Table of Contents - :depth: 3 - ---------------------- -Test Case Description ---------------------- - -Yardstick Test Case ID ----------------------- - -OPNFV_YARDSTICK_TC<abc>_<slogan> - -where: - - <abc>: check Jira issue for the test case - - <slogan>: check Jira issue for the test case - - -Purpose -------- - -Describe what is the purpose of the test case - -Area ----- - -State the area and sub-area covered by the test case. - -Areas: Compute, Networking, Storage - -Sub-areas: Performance, System limit, QoS - -Metrics -------- - -What will be measured, attribute name or collection of attributes, behavior - -References ----------- - -Reference documentation - --------------- -Pre-requisites --------------- - -Tools ------ - -What tools are used to perform the measurements (e.g. fio, pktgen) - - -Configuration -------------- - -State the .yaml file to use. - -State default configuration in the tool(s) used to perform the measurements -(e.g. fio, pktgen). - -State what POD-specific configuration is required to enable running the test -case in different PODs. - - -State SLA, if applicable. - -State test duration. - -------- -Results -------- - -Expected outcome ----------------- - -State applicable graphical presentation - -State applicable output details - -State expected Value, behavior, pass/fail criteria |