From 3f78f83f984553f775f63caaff32dc3c48efff1e Mon Sep 17 00:00:00 2001 From: Ana C Date: Fri, 11 Dec 2015 15:56:08 +0100 Subject: 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 --- docs/index.rst | 52 ---------------------------------------------------- 1 file changed, 52 deletions(-) delete mode 100644 docs/index.rst (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index 36a78321a..000000000 --- a/docs/index.rst +++ /dev/null @@ -1,52 +0,0 @@ -.. OPNFV Yardstick documentation master file. - Add chapters and user guides using the - root `toctree` directive. - -================= -Yardstick Project -================= - -Welcome to Yardstick's documentation ! - -.. _Yardstick: https://wiki.opnfv.org/yardstick - -Yardstick_ is an OPNFV testing project. - -The project goal is to verify infrastructure compliance, from the perspective -of a VNF. - -The project scope is the development of a test framework, test cases and test -stimuli. - -This document introduces the methodology applied in Yardstick_ project, which -decomposes typical VNF work-load performance metrics into a number of -characteristics/performance vectors, each of them can be represented by -distinct test-cases. - -The user guides and test cases delivered for the release are included. - -Contents: - -Yardstick Project Description -============================= - -.. toctree:: - :numbered: - :maxdepth: 2 - -User Guides -=========== - -.. toctree:: - :maxdepth: 1 - - user_guides/framework/03-installation - -Indices -======= - -* :ref:`search` - -Revision: _sha1_ - -Build date: |today| -- cgit 1.2.3-korg