5. Project Name: Documentation

  • Proposed name for the project: ‘’opnfv documentation’‘
  • Proposed name for the repository: ‘’opnfvdocs’‘
  • Project Categories: Documentation

5.1. Project description:

  • 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

5.2. Scope:

  • 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:
    • Release note
    • Install guide
    • User Guide
    • API reference (if there is content in release 1)
    • Interface specification (if there is content in release 1)
  • 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

5.3. Dependencies:

  • All OPNFV projects participating in a release.
  • Upstream project documentation to be referenced
  • Where there are external fora or standard development organization dependencies, list informative and normative references & specifications.

5.4. Committers and Contributors:

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.

5.5. Planned deliverables

  • Project release documentation for OPNFV
    • Including collation of all release relevant project documentations
  • Establishment and maintenance of the OPNFV documentation processes and toolchains

5.6. Proposed Release Schedule:

  • opnfvdocs will follow each OPNFV release and produce needed documentation
    • Release 1 will provide basic documentation including revision control.
    • By release 2 a multi-project toolchain will be in place with processes and version control
    • Iterative improvements to the processes and toolchains are expected on a release by release basis.

Documentation tracking

Revision:

Build date: _date_