docs/documentation/index.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. (c) Open Platform for NFV Project, Inc. and its contributors
   4
   5 *******************
   6 OPNFV Documentation
   7 *******************
   8
   9 ==============================
  10 Colorado Release Documentation
  11 ==============================
  12
  13 OPNFV release documentation is structured with brief platform-level documents referencing
  14 more detailed installation instructions and descriptive documentation.
  15
  16 Platform documentation
  17 ======================
  18
  19 * `OPNFV platform overview document <http://artifacts.opnfv.org/opnfvdocs/colorado/docs/overview/index.html>`_
  20 * `Installation & configuration guide <http://artifacts.opnfv.org/opnfvdocs/colorado/docs/installationprocedure/index.html>`_
  21 * `The OPNFV user guide <http://artifacts.opnfv.org/opnfvdocs/colorado/docs/userguide/index.html>`_
  22
  23 Installation instructions
  24 =========================
  25
  26 * `Apex installation instruction <http://artifacts.opnfv.org/apex/colorado/docs/installationprocedure/index.html>`_
  27 * `Apex release notes <http://artifacts.opnfv.org/apex/colorado/docs/releasenotes/index.html>`_
  28 * `Compass installation instruction <http://artifacts.opnfv.org/compass4nfv/colorado/docs/installationprocedure/index.html>`_
  29 * `Compass release notes <http://artifacts.opnfv.org/compass4nfv/colorado/docs/releasenotes/index.html>`_
  30 * `Fuel installation instruction <http://artifacts.opnfv.org/fuel/colorado/docs/installationprocedure/index.html>`_
  31 * `Fuel release notes <http://artifacts.opnfv.org/fuel/colorado/docs/releasenotes/index.html>`_
  32 * `Joid installation instruction <http://artifacts.opnfv.org/joid/colorado/docs/installationprocedure/index.html>`_
  33 * `Joid release notes <http://artifacts.opnfv.org/joid/colorado/docs/releasenotes/index.html>`_
  34
  35 Feature Project documentation
  36 =============================
  37
  38 ----------------------------------------------
  39 Copper, policy features, release documentation
  40 ----------------------------------------------
  41
  42 * `Copper release documentation <http://artifacts.opnfv.org/copper/colorado/docs/design/index.html>`_
  43
  44 -----------------------------------------------------
  45 Doctor, fault notification, features and capabilities
  46 -----------------------------------------------------
  47
  48 * `The doctor overview document <http://artifacts.opnfv.org/doctor/colorado/docs/platformoverview/index.html>`_
  49 * `Doctor user guide <http://artifacts.opnfv.org/doctor/colorado/docs/userguide/index.html>`_
  50
  51 ----------------------------------------------------------------
  52 Domino, template distribution service, features and capabilities
  53 ----------------------------------------------------------------
  54
  55 * `User guide <http://artifacts.opnfv.org/domino/colorado/docs/userguide/index.html>`_
  56 * `Configuration guide <http://artifacts.opnfv.org/domino/colorado/docs/configguide/index.html>`_
  57
  58 -------------------------------------------------
  59 FastDataStacks feature and scenario documentation
  60 -------------------------------------------------
  61
  62 * `OpenDaylight integrated fd.io scenario description <http://artifacts.opnfv.org/fds/colorado/docs/scenarios_os-odl_l2-fdio-noha/index.html>`_
  63
  64 ------------------------------------
  65 IPv6 platform support and capability
  66 ------------------------------------
  67
  68 * `IPv6 user guide <http://artifacts.opnfv.org/ipv6/colorado/docs/userguide/index.html>`_
  69 * `Installation of routing functions <http://artifacts.opnfv.org/ipv6/colorado/docs/reldoc/index.html>`_
  70
  71 -----------
  72 KVM for NFV
  73 -----------
  74
  75 * `Installation guide <http://artifacts.opnfv.org/kvmfornfv/colorado/docs/installationprocedure/index.html>`_
  76 * `User guide <http://artifacts.opnfv.org/kvmfornfv/colorado/docs/userguide/index.html>`_
  77 * `Configuration guide <http://artifacts.opnfv.org/kvmfornfv/colorado/docs/configurationguide/index.html>`_
  78 * `Release notes <http://artifacts.opnfv.org/kvmfornfv/colorado/docs/releasenotes/index.html>`_
  79
  80 -------------------------
  81 Network readiness project
  82 -------------------------
  83
  84 * `Network readiness report <http://artifacts.opnfv.org/netready/colorado/docs/requirements/index.html>`_
  85
  86 ----------------------
  87 ONOS framework project
  88 ----------------------
  89
  90 * `Installation guide <http://artifacts.opnfv.org/onosfw/colorado/docs/installationprocedure/index.html>`_
  91 * `User guide <http://artifacts.opnfv.org/onosfw/colorado/docs/userguide/index.html>`_
  92
  93 ----------------------------
  94 OVSNFV release documentation
  95 ----------------------------
  96
  97 * `Configuration guide <http://artifacts.opnfv.org/ovsnfv/colorado/docs/configguide/index.html>`_
  98 * `User guide <http://artifacts.opnfv.org/ovsnfv/colorado/docs/userguide/index.html>`_
  99 * `Release notes <http://artifacts.opnfv.org/ovsnfv/colorado/docs/release/index.html>`_
 100 * `OVS for NFV scenario description <http://artifacts.opnfv.org/ovsnfv/colorado/docs/scenarios_os-nosdn-ovs/index.html>`_
 101
 102 --------------
 103 Parser project
 104 --------------
 105
 106 * `Parser release documentation <http://artifacts.opnfv.org/parser/colorado/docs/parser_docs/index.html>`_
 107 * `Installation guide <http://artifacts.opnfv.org/parser/colorado/docs/installationprocedure/index.html>`_
 108 * `User guide <http://artifacts.opnfv.org/parser/colorado/docs/userguide/index.html>`_
 109
 110 Test Project documentation
 111 ==========================
 112
 113 ----------------------
 114 Functest documentation
 115 ----------------------
 116
 117 *  `The Functest configuration guide <http://artifacts.opnfv.org/functest/colorado/docs/configguide/index.html>`_
 118 *  `The Functest user Guide <http://artifacts.opnfv.org/functest/colorado/docs/userguide/index.html>`_
 119 *  `A developer guide for working with functest <http://artifacts.opnfv.org/functest/colorado/docs/devguide/index.html>`_
 120 *  `Functest release Notes <http://artifacts.opnfv.org/functest/colorado/docs/release-notes/functest-release.html>`_
 121
 122 -----------------------
 123 Yardstick documentation
 124 -----------------------
 125
 126 *  `The Yardstick user guide <http://artifacts.opnfv.org/yardstick/colorado/docs/userguide/index.html>`_
 127 *  `A code documentation and developer guide <http://artifacts.opnfv.org/yardstick/colorado/docs/apidocs/index.html>`_
 128 *  `Yardstick release notes <http://artifacts.opnfv.org/yardstick/colorado/docs/release/index.html>`_
 129
 130 -------------------------
 131 vSwitchPerf documentation
 132 -------------------------
 133
 134 * `Release and development documentation  <http://artifacts.opnfv.org/vswitchperf/colorado/docs/index.html>`_
 135
 136 ------------------------------------------------
 137 Software fast-path quality metrics documentation
 138 ------------------------------------------------
 139
 140 * `Release and development documentation <http://artifacts.opnfv.org/fastpathmetrics/colorado/docs/index.html>`_
 141
 142 -------------------------
 143 Bottlenecks documentation
 144 -------------------------
 145
 146 * `Installation procedure <http://artifacts.opnfv.org/bottlenecks/colorado/docs/installationprocedure/index.html>`_