Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Brahmaputra docs for publishing ======

   * Latest released Brahmaputra documentation: https://www.opnfv.org/software/download 
   * Links to latest Documentation: https://wiki.opnfv.org/documentation/library
   * Understanding the documentation: toolchain https://wiki.opnfv.org/documentation 
   * Configuring documentation for your project https://wiki.opnfv.org/documentation/configguide
   

This wiki will provide a guideline for document editorial leading up to the Brahmaputra realease, and further provide a reference for the eventual publication of Brahmaputra 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 Brahmaputra.

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


==== opnfvdocs documentation ====

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

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

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

===== //Start release docs page structure// =====

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

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

  * OPNFV generic installer requirements: [[http://artifacts.opnfv.org/genesisreq/brahmaputra/docs/requirements/index.html]] {{http://artifacts.opnfv.org/genesisreq/brahmaputra/docs/requirements/requirements.pdf|PDF}}
  * OPNFV Apex documentation:         //link to the Apex download page//
  * OPNFV Compass4nfv documentation:  //link to the Compass download page//
  * OPNFV Fuel documentation:         //link to the Fuel download page//
  * OPNFV Joid documentation:         //link to the Joid download page//

==== Brahmaputra feature project documentation ====

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


== OPNFV Doctor documentation ==

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

== OPNFV High Availability Documentation ==

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

== OPNFV IPv6 documentation ==

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

== OPNFV ONOSFW documentation ==

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

== OPNFV Promise documentation ==

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

== OPNFV SFC documentation ==

  * [[http://artifacts.opnfv.org/sfc/brahmaputra/docs/design/index.html|SFC Design document]] {{http://artifacts.opnfv.org/sfc/brahmaputra/docs/design/design.pdf|PDF}}
  * [[http://artifacts.opnfv.org/sfc/brahmaputra/docs/release-notes/index.html|SFC Release notes]] {{http://artifacts.opnfv.org/sfc/brahmaputra/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}}
==== Brahmaputra testing project documentation ====

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


== OPNFV Bottlenecks documentation ==

  * [[http://artifacts.opnfv.org/bottlenecks/brahmaputra/docs/bottlenecks_brahmaputra_docs/index.html|Bottlenecks overview documentation]] {{http://artifacts.opnfv.org/bottlenecks/brahmaputra/docs/bottlenecks_brahmaputra_docs/bottlenecks_brahmaputra_docs.pdf|PDF}}

== OPNFV FUNCTEST documentation ==

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

== OPNFV YARDSTICK documentation ==

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

== OPNFV vSwitchPerf documentation ==

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

Every scenario and feature in OPNFV Brahmaputra 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 Brahmaputra Results ==

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

== YardStick Brahmaputra Results ==


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

===== //End release docs page structure// =====

==== Installer document libraries ====

These need to be added to each installer download page.

== OPNFV Apex documentation ==

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

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


== OPNFV Compass documentation ==

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

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

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


== OPNFV Fuel documentation ==

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

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

OPNFV Fuel release notes:
[[http://artifacts.opnfv.org/fuel/brahmaputra/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]]
Wiki

User Tools

Site Tools

Page Tools
