User Tools

Site Tools


documentation

This is an old revision of the document!


Documentation Page

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.

Enabling the documentation toolchain in your project

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!

How and where to store the document content files in your repository.

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 should establish the following basic structure for your project as needed:

  • Release Documentation
    • <repo>/docs/release/
    • Should be the directory where any release specific documentation (release notes, installation, user guide - content) is produced
  • Requirement Documentation
    • <repo>/requirements/
    • Should be where your requirement documentation is created
    • <repo>/design_docs/
    • Should be where your upstream design documents (blueprints, development proposals, etc..) are stored
    • For details on requirements projects structures see the Requirements Projects page

You can configure the documentation toolchain to generate docs for other directories in your repository manually.

Documentation projects

documentation.1429174946.txt.gz · Last modified: 2015/04/16 09:02 by Christopher Price