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.

• OPNFV Brahmaputra overview document: http://artifacts.opnfv.org/opnfvdocs/brahmaputra/docs/platformoverview/index.html PDF

• OPNFV Brahmaputra configuration guide: http://artifacts.opnfv.org/opnfvdocs/brahmaputra/docs/configguide/index.html PDF

• OPNFV Brahmaputra user guide: http://artifacts.opnfv.org/opnfvdocs/brahmaputra/docs/userguide/index.html PDF

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 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

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.

• Doctor user guide PDF
• Doctor config guide PDF
• Doctor platform overview PDF
• Doctor Manual for OpenStack Nova API PDF

• Requirement doc PDF
• Scenario Analysis doc PDF

• IPv6 Install Guide PDF
• IPv6 Gap Analysis/User Guide PDF
• IPv6 Release Doc PDF

• onosfw user guide
• onosfw config guide
• onosfw release note
• onosfw testing scenario descriptions and results

• Promise user guide PDF
• Promise config guide PDF
• Promise platform overview PDF

• SFC Design document PDF
• SFC Release notes PDF

• OVSNFV User Guide PDF
• OVSNFV Configuration Guide PDF
• OVSNFV Release Notes PDF

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.

• Bottlenecks overview documentation PDF

• Functest Config guide PDF
• Functest User Guide PDF
• Functest Dev guide PDF
• Functest Release Notes PDF

• Yardstick User Guide PDF
• Yardstick Code Documentation PDF
• Yardstick Release Note PDF

• vSwitchPerf collated documentation PDF

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 Test Results Documentation PDF

• Yardstick Test Results Documentation PDF

These need to be added to each installer download page.

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 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 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 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