This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
documentation:opnfvdocs [2015/04/10 22:46] Iben Rodriguez |
documentation:opnfvdocs [2016/03/24 10:47] (current) Sofia Wallin |
||
---|---|---|---|
Line 1: | Line 1: | ||
==== OPNFV documentation project ==== | ==== OPNFV documentation project ==== | ||
- | |||
- | NOTE: this doc is: https://wiki.opnfv.org/documentation/opnfvdocs | ||
=== Project description: === | === Project description: === | ||
* 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. | ||
* Include any architecture diagrams or specifications, reference to OPNFV requirements list. | * Include any architecture diagrams or specifications, reference to OPNFV requirements list. | ||
* Provide guidelines and tooling for documentation handling across all OPNFV projects | * Provide guidelines and tooling for documentation handling across all OPNFV projects | ||
+ | |||
+ | === Current OPNFV documentation 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. | ||
Line 36: | Line 38: | ||
* Trevor Cooper: trevor.cooper@intel.com | * Trevor Cooper: trevor.cooper@intel.com | ||
* Victor Laza <vlaza@cloudbasesolutions.com> | * Victor Laza <vlaza@cloudbasesolutions.com> | ||
+ | * Natasha Peters: natasha.c.peters@gmail.com | ||
Description of roles in the documentation project: | Description of roles in the documentation project: |