releases:brahmaputra:releasedocs
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Last revision Both sides next revision | ||
|
releases:brahmaputra:releasedocs [2016/02/25 14:14] Ryota Mibu [Brahmaputra feature project documentation] |
releases:brahmaputra:releasedocs [2016/03/16 00:01] Aric Gardner |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== Brahmaputra docs for publishing ====== | ====== Brahmaputra docs for publishing ====== | ||
| + | |||
| + | * Latest released documentation: https://www.opnfv.org/software/download | ||
| + | * Understanding the documentation: toolchain https://wiki.opnfv.org/documentation | ||
| 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. | 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. | ||
| Line 10: | Line 13: | ||
| ==== opnfvdocs documentation ==== | ==== opnfvdocs documentation ==== | ||
| - | OPNFV Brahmaputra overview document: | + | * 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}} |
| - | [[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: | + | * 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}} |
| - | [[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: | + | * 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}} |
| - | [[http://artifacts.opnfv.org/opnfvdocs/brahmaputra/docs/userguide/index.html]] {{http://artifacts.opnfv.org/opnfvdocs/brahmaputra/docs/userguide/index.html|PDF}} | + | |
| ===== //Start release docs page structure// ===== | ===== //Start release docs page structure// ===== | ||
| Line 26: | Line 25: | ||
| These documents relate to the installation and deployment of the Brahmaputra Platform. | These documents relate to the installation and deployment of the Brahmaputra Platform. | ||
| - | * OPNFV generic installer requirements: [[http://artifacts.opnfv.org/genesisreq/brahmaputra/requirements/index.html]] {{http://artifacts.opnfv.org/genesisreq/brahmaputra/requirements/requirements.pdf|PDF}} | + | * 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 Apex documentation: //link to the Apex download page// | ||
| * OPNFV Compass4nfv documentation: //link to the Compass download page// | * OPNFV Compass4nfv documentation: //link to the Compass download page// | ||
| Line 47: | Line 46: | ||
| * Requirement doc {{:releases:brahmaputra:ha_requirement.pdf|PDF}} | * Requirement doc {{:releases:brahmaputra:ha_requirement.pdf|PDF}} | ||
| - | |||
| * Scenario Analysis doc {{:releases:brahmaputra:scenario_analysis_for_high_availability_in_nfv.pdf|PDF}} | * Scenario Analysis doc {{:releases:brahmaputra:scenario_analysis_for_high_availability_in_nfv.pdf|PDF}} | ||
| Line 55: | Line 53: | ||
| * [[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/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}} | * [[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 Multisite documentation == | ||
| - | |||
| - | * [[http://artifacts.opnfv.org/multisite/userguide/multisite-admin-user-guide.html|Multisite user guide]] {{http://artifacts.opnfv.org/multisite/userguide/userguide.pdf|PDF}} | ||
| - | * [[http://artifacts.opnfv.org/multisite/configguide/multisite-configuration-guide.html|Multisite configuration guide]] {{http://artifacts.opnfv.org/multisite/configguide/configguide.pdf|PDF}} | ||
| == OPNFV ONOSFW documentation == | == OPNFV ONOSFW documentation == | ||
| * [[http://artifacts.opnfv.org/onosfw/brahmaputra/docs/userguide/index.html|onosfw user guide]] | * [[http://artifacts.opnfv.org/onosfw/brahmaputra/docs/userguide/index.html|onosfw user guide]] | ||
| - | * [[http://artifacts.opnfv.org/onosfw/brahmaputra/docs/Brahmaputra_configguide/index.html|onosfw config 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/release/index.html|onosfw release note]] | ||
| * [[http://artifacts.opnfv.org/onosfw/brahmaputra/docs/Brahmaputra_docs_scenario/index.html|onosfw testing scenario descriptions and results]] | * [[http://artifacts.opnfv.org/onosfw/brahmaputra/docs/Brahmaputra_docs_scenario/index.html|onosfw testing scenario descriptions and results]] | ||
| Line 77: | Line 70: | ||
| * [[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/design/index.html|SFC Design document]] {{http://artifacts.opnfv.org/sfc/brahmaputra/docs/design/design.pdf|PDF}} | ||
| - | * [[http://artifacts.opnfv.org/sfc/review/10803/release-notes/index.html|SFC Release notes]] {{http://artifacts.opnfv.org/sfc/review/10803/release-notes/release-notes.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 == | == Open vSwitch for NFV documentation == | ||
| Line 91: | Line 84: | ||
| == OPNFV Bottlenecks documentation == | == OPNFV Bottlenecks documentation == | ||
| - | Bottlenecks overview 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}} |
| - | [[http://artifacts.opnfv.org/bottlenecks/docs/bottlenecks_brahmaputra_docs/index.html]] | + | |
| == OPNFV FUNCTEST documentation == | == OPNFV FUNCTEST documentation == | ||
| - | * [[http://artifacts.opnfv.org/functest/brahmaputra/docs/configguide/index.html|Functest Config guide (HTML)]] | + | * [[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/configguide/configguide.pdf|Functest Config guide (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/userguide/index.html|Functest User Guide (HTML)]] | + | * [[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/userguide/userguide.pdf|Functest User Guide (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}} |
| - | * [[http://artifacts.opnfv.org/functest/docs/devguide/index.html|Functest Dev guide (HTML)]] | + | |
| - | * [[http://artifacts.opnfv.org/functest/docs/devguide/devguide.pdf|Functest Dev guide (PDF)]] | + | |
| - | * [[http://artifacts.opnfv.org/functest/docs/results/index.html| Functest artifacts]] | + | |
| - | * Notes: | + | |
| - | * [[http://artifacts.opnfv.org/functest/docs/release-notes/index.html | Release Notes (HTML)]] | + | |
| - | * [[http://artifacts.opnfv.org/functest/docs/release-notes/release-notes.pdf | Release Notes (PDF)]] | + | |
| - | + | ||
| == OPNFV YARDSTICK documentation == | == OPNFV YARDSTICK documentation == | ||
| - | * [[http://artifacts.opnfv.org/yardstick/brahmaputra/docs/userguide/index.html|Yardstick User Guide (HTML)]] | + | * [[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/userguide/userguide.pdf|Yardstick User Guide (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/apidocs/index.html|Yardstick Code Documentation (HTML)]] | + | * [[http://artifacts.opnfv.org/yardstick/brahmaputra/docs/release/index.html|Yardstick Release Note]] {{http://artifacts.opnfv.org/yardstick/brahmaputra/docs/release/release.pdf|PDF}} |
| - | * [[http://artifacts.opnfv.org/yardstick/brahmaputra/docs/apidocs/apidocs.pdf|Yardstick Code Documentation(PDF)]] | + | |
| - | * [[http://artifacts.opnfv.org/yardstick/brahmaputra/docs/release/index.html|Yardstick Release Note (HTML)]] | + | |
| - | * [[http://artifacts.opnfv.org/yardstick/brahmaputra/docs/release/release.pdf|Yardstick Release Note (PDF)]] | + | |
| - | * [[http://artifacts.opnfv.org/yardstick/brahmaputra/docs/results/index.html| Yardstick Test Results Documentation (HTML)]] | + | |
| - | * [[http://artifacts.opnfv.org/yardstick/brahmaputra/docs/results/results.pdf| Yardstick Test Results Documentation (PDF)]] | + | |
| - | + | ||
| == OPNFV vSwitchPerf documentation == | == OPNFV vSwitchPerf documentation == | ||
| - | vSwitchPerf collated documentation: | + | * [[http://artifacts.opnfv.org/vswitchperf/brahmaputra/docs/index.html|vSwitchPerf collated documentation]] {{http://artifacts.opnfv.org/vswitchperf/brahmaputra/docs/docs.pdf|PDF}} |
| - | [[http://artifacts.opnfv.org/vswitchperf/brahmaputra/docs/index.html]] | + | |
| ==== Brahmaputra test results documentation ==== | ==== Brahmaputra test results documentation ==== | ||
| Line 134: | Line 108: | ||
| == FuncTest Brahmaputra Results == | == FuncTest Brahmaputra Results == | ||
| - | * [[http://artifacts.opnfv.org/functest/brahmaputra/docs/results/index.html| Functest Test Results Documentation (html)]] | + | * [[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}} |
| - | * [[http://artifacts.opnfv.org/functest/brahmaputra/docs/results/results.pdf| Functest Test Results Documentation (pdf)]] | + | |
| - | * [[http://artifacts.opnfv.org/functest/brahmaputra/docs/release-notes/index.html| Functest Test Release Notes (html)]] | + | |
| - | * [[http://artifacts.opnfv.org/functest/brahmaputra/docs/release-notes/release-notes.pdf| Functest Test Release Notes (pdf)]] | + | |
| == YardStick Brahmaputra Results == | == YardStick Brahmaputra Results == | ||
| - | * [[http://artifacts.opnfv.org/yardstick/brahmaputra/docs/results/index.html| Yardstick Test Results Documentation (html)]] | + | * [[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}} |
| - | * [[http://artifacts.opnfv.org/yardstick/brahmaputra/docs/results/results.pdf| Yardstick Test Results Documentation (pdf)]] | + | |
| - | * [[http://artifacts.opnfv.org/yardstick/brahmaputra/docs/release/index.html| Yardstick Test Release Notes (html)]] | + | |
| - | * [[http://artifacts.opnfv.org/yardstick/brahmaputra/docs/release/release.pdf| Yardstick Test Release Notes (pdf)]] | + | |
| ===== //End release docs page structure// ===== | ===== //End release docs page structure// ===== | ||
releases/brahmaputra/releasedocs.txt · Last modified: 2016/03/16 17:51 by Aric Gardner
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: Creative Commons Attribution 4.0 International License
