Page tree
Skip to end of metadata
Go to start of metadata


Welcome to the OPNFVDOCS project page
Project description:
  • Support in producing documentation for OPNFV releases
  • Define guidelines and tooling for documentation handling across all OPNFV projects
  • Include any architecture diagrams or specifications, reference to OPNFV requirements list
  • Maintain the OPNFV documentation libraries 
Working with documents in OPNFV
You can find an up to date description of working with docs in OPNFV including using the docs toolchain on your local computer.
You can also check the developer information wiki area for the OPNFV Documentation Toolchain.
Current OPNFV documentation library
Colorado documentation library
    • 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
    • Develop initial set of release documents:
      • Installation & Configuration guide
      • User Guide
      • Overview
      • Releas notes
    • Provide language guidance and document rendering options. All documents should be written in English. Available formatting for Colorado release is HTML and PDF format
    • Provide processes and tooling for OPNFV projects to implement and follow for consistency
Danube release planning
Epics will be created for all overall documentation with attached sub-tasks assigned to all projects. Expected is a cross reference flow. Projects will handle user stories for documentation within their own backlogs but with a reference to user story in the OPNVFDOCS backlog. This is to facilitate follow up and to make the work visible for both parties.

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.

Bi weekly docs meeting,



Key Project Facts

Project: OPNFV documentation project (opnfvdocs)
Project Creation Date: March 31, 2015
Project Category: Documentation
Lifecycle State: Incubation
Primary Contact: Sofia Wallin (
Project Lead: Sofia Wallin (
Jira Project Name: OPNFV documentation project
Jira Project Prefix: DOCS
Mailing list tag: [docs]
IRC: Channel:#opnfv
Repository: opnfvdocs


Link to TSC approval of the project:
Link(s) to approval of additional committers:
* Approval of Victor Laza as a committer:
* Approval of Ryota Mibu as a committer:
* Approval of Sofia Wallin as a committer:

Additional contributors







  • No labels