The user guide is an OPNFV release document that describes how to use and configure the system to use OPNFV features once the base platform installation and configuration is complete. The document describes the general usage of the system and the methods of leveraging OPNFV features for an operator of applicatons running on the OPNFV platform.

The document is structured around an index.rst file in the opnfvdocs repository. This file is used to construct and collate the various document elements both from the opnfvdocs repository and project specific user guide documentation.

If you intend to deliver features into the platform that provide specific behaviours with feature configurations you must provide input for this document. The document structure and methods of providing input are described below.

The user guide is hosted in the opnfvdocs repository and consists of these global files:

The document is further compiled of project specific chapters, feature configuration descriptions, and validation procedures. Every project providing features into the platform must provide a description in this document on how to use the features.

All project specific files to be compiled into the user guide must be stored in your projects userguide folder.

Add your documentation to your repository in the folder structure and according to the templates listed above. The documentation templates you will require are available in the opnfvdocs repository, you should copy the relevant templates to the /docs/userguide directory in your repository. For instance if I wanted to document enabling my feature set in the platform I would follow an example like:

' mkdir <my_repo>/docs/userguide '
' git clone ssh://<your_id>@gerrit.opnfv.org:29418/opnfvdocs.git '
' cp opnfvdocs/docs/userguide/featureusage.rst <my_repo>/docs/userguide '
' cp opnfvdocs/docs/userguide/validation.rst <my_repo>/docs/userguide '

You should then add the relevant information to the template that will explain the usage of your feature and instructions for validating that the feature was used successfully like checking the results of specific test cases.

Once your documentation is ready you should ensure they are compiled into the master file by adding them to the master index.rst file in the opnfvdocs repository. The index.rst fils is structured in such a way that you should refer to your document in the correct section of the index.rst document structure. The relevant sections for compiling project specific information are:

• Feature Description - for adding feature specific usage information
• Validation Activities - describing how to validate the usage was performed successfully

An example of how to add your documentation to the relevant sections of the index.rst file might be:

' git clone ssh://<your_id>@gerrit.opnfv.org:29418/opnfvdocs.git '
' cd opnfvdocs ' 
' git review -s '
' vim docs/userguide/index.rst '

At this point you should add the references to your files into the index.rst file, for instance in the feature description section you would add ../../<my_repo>/docs/userguide/featureusage.rst and in the Post Configuration Activities section you would add ../../<my_repo>/docs/userguide/validation.rst. Once you have made these changes you need to push the patch back to the opnfvdocs team for review and integration.

' git add . '
' git commit --signoff --all '
' git review '

Be sure to add the project leader of the opnfvdocs project as a reviewer of the change you just pushed in gerrit. Also be aware that once the text is available in the context of the broader release document it may require some revising and editorial work to prepare it for release.