OPNFV documentation is automated and integrated into our git & gerrit toolchains.

We use RST document templates in our repositories and automatically render to HTML and PDF versions of the documents in our artfecact store, our WiKi is able to integrate these rendered documents directly allowing projects to use the revision controlled documentation process for project information, content and deliverables.

There are some basic steps you will need to perform in order to get the toolchain working in your repository, this include setting up Jenkins jobs and establishing your project documentation structure. See the documents toolchain instructions for more details on getting started in your project. The linked page above is written completely in generated artifacts, check the source to see how to do it yourself!

While many of your documents may be specific to your work there is a general structure proposed for storing and handling documents that are common across many projects. You are encouraged to establish the following basic structure for your project as needed:

• Requirement Documentation: <repo>/docs/requirements/
  • Should be where your requirement documentation is created

• Design Documentation: <repo>/docs/design/
  • Should be where your upstream design documents (blueprints, development proposals, etc..) are stored
  • For details on requirements projects structures see the Requirements Projects page

• Release Documentation: <repo>/docs/release/
  • Should be the directory where any release specific documentation (release notes) is produced

• Platform Overview: <project dir>/docs/platformoverview
  • Should be where overview of a release deliverable is placed
  • Note this document will be compiled into OPNFVDOCS 'paltformoverview'

• Installation Manual: <project dir>/docs/configguide
  • Should be where manuals to install/configure project specific components and features are stored
  • Guides to validate project specific features can be included
  • Note this document will be compiled into OPNFVDOCS 'configguide'

• User Guide: <project dir>/docs/userguide
  • Should be where manuals to use specific features are stored
  • Can be the directory where API reference for project specific features are stored
  • Can be where typical scenario is stored as an example
  • Note this document will be compiled into OPNFVDOCS 'userguide'

Any other documentation can be created under <repo>/docs/ with directory name excluding names in this list.

OPNFV Documentation Project