documentation:opnfvdocs
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
documentation:opnfvdocs [2016/03/07 13:07] Christopher Price |
documentation:opnfvdocs [2016/03/24 10:47] (current) Sofia Wallin |
||
|---|---|---|---|
| Line 4: | Line 4: | ||
| * Produce documentation for OPNFV releases including but not limited to: | * Produce documentation for OPNFV releases including but not limited to: | ||
| * Release notes | * Release notes | ||
| - | * Installation guide | + | * Configuration guide |
| * User guide | * User guide | ||
| * Any relevant references and interface specifications for OPNFV projects or components. | * Any relevant references and interface specifications for OPNFV projects or components. | ||
| Line 12: | Line 12: | ||
| === Current OPNFV documentation library === | === Current OPNFV documentation library === | ||
| - | [[https://wiki.opnfv.org/documentation/opnfvdocs/library]] | + | [[https://wiki.opnfv.org/documentation/library]] |
| === Current plans: === | === Current plans: === | ||
| - | * Set up a structure, and a template, for document development with source control (same as source code). Leveraging upstream documentation structure and tools. | + | * Set up a structure, and templates, for document development with source control (same as source code). Leveraging upstream documentation structure and tools. |
| * Following as close as possible the same contribution process & tools as our source code | * Following as close as possible the same contribution process & tools as our source code | ||
| * Structure OPNFV documentation logically | * Structure OPNFV documentation logically | ||
| * Develop initial set of release documents: | * Develop initial set of release documents: | ||
| * (A) Release note - should be mostly a template in opnfvdocs and read in from the different areas -release components, ISO toolchain contents, test coverage, links to other docs | * (A) Release note - should be mostly a template in opnfvdocs and read in from the different areas -release components, ISO toolchain contents, test coverage, links to other docs | ||
| - | * (B) Install guide - should contain sections on: getting the software: centrally done in opnfvdocs, preparing your hardware: taken from pharos, installing the ISO: taken from each ISO directory, validating the install: taken from functest | + | * (B) Config guide - should contain sections on: getting the software: centrally done in opnfvdocs, preparing your hardware: taken from pharos, installing the ISO: taken from each ISO directory, validating the install: taken from functest |
| * (C) User Guide - overview of the platform: central overview of tools taken from each ISO directory. instruction on deploying to the platform: maybe taken from functest | * (C) User Guide - overview of the platform: central overview of tools taken from each ISO directory. instruction on deploying to the platform: maybe taken from functest | ||
| * Provide language options for documentation where applicable: In first release English only, Wiki (via HTML scraping from Gerrit), and PDF. | * Provide language options for documentation where applicable: In first release English only, Wiki (via HTML scraping from Gerrit), and PDF. | ||
documentation/opnfvdocs.1457356037.txt.gz ยท Last modified: 2016/03/07 13:07 by Christopher Price
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: Creative Commons Attribution 4.0 International License
