====== OPNFV documentation library ======

This wiki will provide a guideline for document editorial leading up to the next release, and further provide a reference for the eventual publication of release related documentation.  

Please add your project information below and the links to the documents you intend to publish for your project, the opnfvdocs team will help by reviewing your documents and setting consistent editorial structure across our documentation for OPNFV.

===== Release documents to be published =====


==== opnfvdocs documentation ====

  * OPNFV overview document: [[http://artifacts.opnfv.org/opnfvdocs/docs/platformoverview/index.html]] {{http://artifacts.opnfv.org/opnfvdocs/docs/platformoverview/platformoverview.pdf|PDF}}

  * OPNFV configuration guide: [[http://artifacts.opnfv.org/opnfvdocs/docs/configguide/index.html]] {{http://artifacts.opnfv.org/opnfvdocs/docs/configguide/configguide.pdf|PDF}}

  * OPNFV user guide: [[http://artifacts.opnfv.org/opnfvdocs/docs/userguide/index.html]] {{http://artifacts.opnfv.org/opnfvdocs/docs/userguide/userguide.pdf|PDF}}


==== OPNFV feature project documentation ====

Feature documentation provides descriptions of the features, architecture and capabilities the OPNFV community has been developing in the next release.  Here you will find details on how to use, deploy or develop features delivered in OPNFV.


== OPNFV Doctor documentation ==

  * [[http://artifacts.opnfv.org/doctor/docs/userguide/index.html|Doctor user guide]] {{http://artifacts.opnfv.org/doctor/docs/userguide/userguide.pdf|PDF}}
  * [[http://artifacts.opnfv.org/doctor/docs/configguide/index.html|Doctor config guide]] {{http://artifacts.opnfv.org/doctor/docs/configguide/configguide.pdf|PDF}}
  * [[http://artifacts.opnfv.org/doctor/docs/platformoverview/index.html|Doctor platform overview]] {{http://artifacts.opnfv.org/doctor/docs/platformoverview/platformoverview.pdf|PDF}}
  * [[http://artifacts.opnfv.org/doctor/docs/manuals/index.html|Doctor Manual for OpenStack Nova API]] {{http://artifacts.opnfv.org/doctor/docs/manuals/manuals.pdf|PDF}}

== OPNFV High Availability Documentation ==

  * Requirement doc {{:releases:ha_requirement.pdf|PDF}}
  * Scenario Analysis doc {{:releases:scenario_analysis_for_high_availability_in_nfv.pdf|PDF}}

== OPNFV IPv6 documentation ==

  * [[http://artifacts.opnfv.org/ipv6/docs/setupservicevm/index.html|IPv6 Install Guide]] {{http://artifacts.opnfv.org/ipv6/docs/setupservicevm/setupservicevm.pdf|PDF}}
  * [[http://artifacts.opnfv.org/ipv6/docs/gapanalysis/index.html|IPv6 Gap Analysis/User Guide]] {{http://artifacts.opnfv.org/ipv6/docs/gapanalysis/gapanalysis.pdf|PDF}}
  * [[http://artifacts.opnfv.org/ipv6/docs/reldoc/index.html|IPv6 Release Doc]] {{http://artifacts.opnfv.org/ipv6/docs/reldoc/reldoc.pdf|PDF}}

== OPNFV ONOSFW documentation ==

  * [[http://artifacts.opnfv.org/onosfw/docs/userguide/index.html|onosfw user guide]]
  * [[http://artifacts.opnfv.org/onosfw/docs/configguide/|onosfw config guide]]
  * [[http://artifacts.opnfv.org/onosfw/docs/release/index.html|onosfw release note]]
  * [[http://artifacts.opnfv.org/onosfw/docs/Brahmaputra_docs_scenario/index.html|onosfw testing scenario descriptions and results]]

== OPNFV Promise documentation ==

  * [[http://artifacts.opnfv.org/promise/docs/userguide/index.html|Promise user guide]] {{http://artifacts.opnfv.org/promise/docs/userguide/userguide.pdf|PDF}}
  * [[http://artifacts.opnfv.org/promise/docs/configguide/index.html|Promise config guide]] {{http://artifacts.opnfv.org/promise/docs/configguide/configguide.pdf|PDF}}
  * [[http://artifacts.opnfv.org/promise/docs/platformoverview/index.html|Promise platform overview]] {{http://artifacts.opnfv.org/promise/docs/platformoverview/platformoverview.pdf|PDF}} 

== OPNFV SFC documentation ==

  * [[http://artifacts.opnfv.org/sfc/docs/design/index.html|SFC Design document]] {{http://artifacts.opnfv.org/sfc/docs/design/design.pdf|PDF}}
  * [[http://artifacts.opnfv.org/sfc/docs/release-notes/index.html|SFC Release notes]] {{http://artifacts.opnfv.org/sfc/docs/release-notes/release-notes.pdf|PDF}}

== Open vSwitch for NFV documentation ==

  * [[http://artifacts.opnfv.org/ovsnfv/docs/userguide/index.html|OVSNFV User Guide]] {{http://artifacts.opnfv.org/ovsnfv/docs/userguide/userguide.pdf|PDF}}
  * [[http://artifacts.opnfv.org/ovsnfv/docs/configguide/index.html|OVSNFV Configuration Guide]] {{http://artifacts.opnfv.org/ovsnfv/docs/configguide/configguide.pdf|PDF}}
  * [[http://artifacts.opnfv.org/ovsnfv/docs/release/index.html|OVSNFV Release Notes]] {{http://artifacts.opnfv.org/ovsnfv/docs/release/release.pdf|PDF}}

==== OPNFV testing project documentation ====

Feature documentation provides descriptions of the features, architecture and capabilities the OPNFV community has been developing in the next release.  Here you will find details on how to use, deploy or develop features delivered in OPNFV.

== OPNFV FUNCTEST documentation ==

  * [[http://artifacts.opnfv.org/functest/docs/configguide/index.html|Functest Config guide]] {{http://artifacts.opnfv.org/functest/docs/configguide/configguide.pdf|PDF}}
  * [[http://artifacts.opnfv.org/functest/docs/userguide/index.html|Functest User Guide]] {{http://artifacts.opnfv.org/functest/docs/userguide/userguide.pdf|PDF}}
  * [[http://artifacts.opnfv.org/functest/docs/devguide/index.html|Functest Dev guide]] {{http://artifacts.opnfv.org/functest/docs/devguide/devguide.pdf|PDF}}
  * [[http://artifacts.opnfv.org/functest/docs/release-notes/index.html|Functest Release Notes]] {{http://artifacts.opnfv.org/functest/docs/release-notes/release-notes.pdf|PDF}}

== OPNFV YARDSTICK documentation ==

  * [[http://artifacts.opnfv.org/yardstick/docs/userguide/index.html|Yardstick User Guide]] {{http://artifacts.opnfv.org/yardstick/docs/userguide/userguide.pdf|PDF}}
  * [[http://artifacts.opnfv.org/yardstick/docs/apidocs/index.html|Yardstick Code Documentation]] {{http://artifacts.opnfv.org/yardstick/docs/apidocs/apidocs.pdf|PDF}}
  * [[http://artifacts.opnfv.org/yardstick/docs/release/index.html|Yardstick Release Note]] {{http://artifacts.opnfv.org/yardstick/docs/release/release.pdf|PDF}}

== OPNFV vSwitchPerf documentation ==

  * [[http://artifacts.opnfv.org/vswitchperf/docs/index.html|vSwitchPerf collated documentation]] {{http://artifacts.opnfv.org/vswitchperf/docs/docs.pdf|PDF}}
  * 
==== OPNFV test results documentation ====

Every scenario and feature in OPNFV has undergone a series of tests and evaluations prior to our release.  The test results documentation provides detailed test results for each test tool executed and scenario prepared for deployment.

== FuncTest Results ==

  * [[http://artifacts.opnfv.org/functest/docs/results/index.html|Functest Test Results Documentation]] {{http://artifacts.opnfv.org/functest/docs/results/results.pdf|PDF}}

== YardStick Results ==


  * [[http://artifacts.opnfv.org/yardstick/docs/results/index.html| Yardstick Test Results Documentation]] {{http://artifacts.opnfv.org/yardstick/docs/results/results.pdf|PDF}}

==== Platform and deployment documentation ====

These documents relate to the installation and deployment of the OPNFV Platform.  

  * OPNFV generic installer requirements: [[http://artifacts.opnfv.org/genesisreq/docs/requirements/index.html]] {{http://artifacts.opnfv.org/genesisreq/docs/requirements/requirements.pdf|PDF}}

=== OPNFV Apex documentation ===

OPNFV Apex detailed installation instructions:
[[http://artifacts.opnfv.org/apex/docs/installation-instructions/index.html]]

OPNFV Apex release notes:
[[http://artifacts.opnfv.org/apex/docs/release-notes/index.html]]


=== OPNFV Compass documentation ===

OPNFV Compass detailed installation instructions:
[[http://artifacts.opnfv.org/compass4nfv/docs/Brahmaputra_installation-instructions/index.html]]

OPNFV Compass release notes:
[[http://artifacts.opnfv.org/compass4nfv/docs/Brahmaputra_release-notes/index.html]]

OPNFV Compass user guide:
[[http://artifacts.opnfv.org/compass4nfv/docs/how-to-use-compass4nfv/index.html]]


=== OPNFV Fuel documentation ===

OPNFV Fuel build instructions:
[[http://artifacts.opnfv.org/fuel/docs/build-instruction.html]]

OPNFV Fuel detailed installation instructions:
[[http://artifacts.opnfv.org/fuel/docs/installation-instruction.html]]

OPNFV Fuel release notes:
[[http://artifacts.opnfv.org/fuel/docs/release-notes.html]]

=== OPNFV JOID documentation ===

OPNFV JOID configuration guide:
[[http://artifacts.opnfv.org/joid/docs/configguide/index.html]]

OPNFV JOID user guide:
[[http://artifacts.opnfv.org/joid/docs/userguide/index.html]]

OPNFV JOID release notes:
[[http://artifacts.opnfv.org/joid/docs/release-notes/release-notes.html]]