Remove etc and source folder from yardstick documentation

conf.py and logo will come from releng which is common for all projects.
The directory structure in docs folder has not been decided yet so this
change does not require you to change your current way of working.

Once this directory structure is decided by opnfvdocs and releng, the changes
need to be reflected back to all projects, including yardstick.

Change-Id: If0558474a819f4a44e34f790d26c5486751b8266
Signed-off-by: Fatih Degirmenci <fatih.degirmenci@ericsson.com>

1 files changed, 94 insertions, 0 deletions

diff --git a/docs/templates/testcase_description_template.rst b/docs/templates/testcase_description_template.rst
new file mode 100644
index 000000000..1651d360c
--- /dev/null
+++ b/docs/templates/testcase_description_template.rst
@@ -0,0 +1,94 @@
+.. 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