X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Ftemplates%2Ftestcase_description_v2_template.rst;h=1b8754b05b013f2c7d82b09d605346a583560143;hb=463a69e878d891b897fe70af15434615baf6a2e9;hp=da90f561e2466313d83604d412726d970badfbc4;hpb=b74bb6b8557c6340daf1ff5a2966df830a6cc53d;p=yardstick.git

diff --git a/docs/templates/testcase_description_v2_template.rst b/docs/templates/testcase_description_v2_template.rst
index da90f561e..1b8754b05 100644
--- a/docs/templates/testcase_description_v2_template.rst
+++ b/docs/templates/testcase_description_v2_template.rst
@@ -9,37 +9,56 @@ Yardstick Test Case Description TCXXX
 
 +-----------------------------------------------------------------------------+
 |test case slogan e.g. Network Latency                                        |
-+==============+==============================================================+
+|                                                                             |
++--------------+--------------------------------------------------------------+
 |test case id  | e.g. OPNFV_YARDSTICK_TC001_NW Latency                        |
+|              |                                                              |
 +--------------+--------------------------------------------------------------+
 |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 sequence | description and expected result                              |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
+|step 1        | use this to describe tests that require sveveral steps e.g   |
+|              | collect logs.                                                |
+|              |                                                              |
+|              | Result: what happens in this step e.g. logs collected        |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
+|step 2        | remove interface                                             |
+|              |                                                              |
+|              | Result: interface down.                                      |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
+|step N        | what is done in step N                                       |
+|              |                                                              |
+|              | Result: what happens                                         |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
 |test verdict  | expected behavior, or SLA, pass/fail criteria                |
+|              |                                                              |
 +--------------+--------------------------------------------------------------+