Page tree
Skip to end of metadata
Go to start of metadata

Brahmaputra docs for publishing

 

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

Start release docs page structure

Platform and deployment documentation

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

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
OPNFV High Availability Documentation
  • Requirement doc PDF
  • Scenario Analysis doc PDF
OPNFV IPv6 documentation
OPNFV ONOSFW documentation
OPNFV Promise documentation
OPNFV SFC documentation
Open vSwitch for NFV documentation

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
OPNFV FUNCTEST documentation
OPNFV YARDSTICK documentation
OPNFV vSwitchPerf documentation

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
YardStick Brahmaputra Results

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

  • No labels