docs/index.rst

   1 .. OPNFV Yardstick documentation master file.
   2    Add chapters and user guides using the
   3    root `toctree` directive.
   4
   5 =================
   6 Yardstick Project
   7 =================
   8
   9 Welcome to Yardstick's documentation !
  10
  11 .. _Yardstick: https://wiki.opnfv.org/yardstick
  12
  13 Yardstick_ is an OPNFV testing project.
  14
  15 The project goal is to verify infrastructure compliance, from the perspective
  16 of a VNF.
  17
  18 The project scope is the development of a test framework, test cases and test
  19 stimuli.
  20
  21 This document introduces the methodology applied in Yardstick_ project, which
  22 decomposes typical VNF work-load performance metrics into a number of
  23 characteristics/performance vectors, each of them can be represented by
  24 distinct test-cases.
  25
  26 The user guides and test cases delivered for the release are included.
  27
  28 Contents:
  29
  30 Yardstick Project Description
  31 =============================
  32
  33 .. toctree::
  34    :numbered:
  35    :maxdepth: 2
  36
  37 User Guides
  38 ===========
  39
  40 .. toctree::
  41     :maxdepth: 1
  42
  43     user_guides/framework/03-installation
  44
  45 Indices
  46 =======
  47
  48 * :ref:`search`
  49
  50 Revision: _sha1_
  51
  52 Build date: |today|