docs/source/index.rst

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