diff options
| author |   Aric Gardner <agardner@linuxfoundation.org> | 2015-09-11 15:59:04 -0400 |
|---|---|---|
| committer |   Ana Cunha <ana.cunha@ericsson.com> | 2015-09-16 12:41:10 +0000 |
| commit | a042da193676747320ca7cac75d1c70ade9a3c04 (patch) | |
| tree | d5a9f0f9cfbe36f1f346d7082fe7c56fef538c05 /docs/to-be-reorganized/testcase_description_template.rst | |
| parent | 2aa1cd3922f26b9d8c9bdad310463caa5eeb8136 (diff) | |
Move documentation to new sphinx build
TODO: Reorganize documentation into properly named subfolders
TODO: Add logos to documentation (see index.rst for example)
Note you can see the results of this change via a link in the gerrit
comments below
NOTE: The merge job for your project has not been enabled, this code
will not go to the artifacts page upon a merge. you can merge it and
work on it in your own time, please contact me to enable the merge
(the merge job will make this documentation avaliable to the public on
artifacts.opnfv.org)
JIRA:RELENG-15
Change-Id: I8fd519393416e2ac2b3ada6fe0670aa4d038fc87
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
Diffstat (limited to 'docs/to-be-reorganized/testcase_description_template.rst')
| -rw-r--r-- | docs/to-be-reorganized/testcase_description_template.rst | 88 |
1 files changed, 88 insertions, 0 deletions
diff --git a/docs/to-be-reorganized/testcase_description_template.rst b/docs/to-be-reorganized/testcase_description_template.rst new file mode 100644 index 000000000..899554dec --- /dev/null +++ b/docs/to-be-reorganized/testcase_description_template.rst @@ -0,0 +1,88 @@ +.. NOTE:: + 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 directory. Review in Gerrit. + +****************** +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 + + + |