Wiki

• Produce documentation for OPNFV releases including but not limited to:
  • Release notes
  • Installation guide
  • User guide
  • Any relevant references and interface specifications for OPNFV projects or components.
• Include any architecture diagrams or specifications, reference to OPNFV requirements list.
• Provide guidelines and tooling for documentation handling across all OPNFV projects

• Set up a structure, and a template, 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
• Structure OPNFV documentation logically
• 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
  • (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
  • (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 tooling and processes for OPNFV projects to implement and follow for consistency

• Additional contributors
  • Bryan Sullivan (AT&T)
  • Trevor Cooper: trevor.cooper@intel.com
  • Victor Laza vlaza@cloudbasesolutions.com
  • Natasha Peters: natasha.c.peters@gmail.com

Description of roles in the documentation project:

• Committers (Editors): has overall responsibility of document structure, editing, style and toolchains
• opnfvdocs contributors: individual section will have contributors who are domain experts in those areas, other contributors may simply help out working on the documentation and tools as needed.
• other projects: Committers will be responsible for maintaining documentation artifacts in project repositories.