The Installation and Configuration guide is an OPNFV release document that describes how to configure the system to an operational state. The document describes both the minimum configuration required to install the platform using the OPNFV installation tools, and associated project configration parameters to enable delivered platform features.

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 configuration documentation.

If you intend to deliver features into the platform that requires specific components and or configurations to enable it you must provide input for this document. The document structure and methods of providing input are described below.

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

The document is further compiled of project specific chapters, these include installation tool descriptions, feature configuration descriptions, and post installation validation procedures. Every project providing features into the platform that requires the configuration of specific components or features in the platform must provide a description in this document on how to enable the features. Please note: this covers only the configuration of the platform to enable the features or components, not the use of those features which is covered in the OPNFV user guide.

All project specific files to be compiled into the Installation and Configuration guide must be stored in your projects configguide 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/configguide 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/configguide '
' git clone ssh://<your_id>@gerrit.opnfv.org:29418/opnfvdocs.git '
' cp opnfvdocs/docs/configguide/featureconfig.rst <my_repo>/docs/configguide '
' cp opnfvdocs/docs/configguide/postinstall.rst <my_repo>/docs/configguide '

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

Once your installer or feature 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:

• Installation Description - for adding installation tool configuration information
• Feature Description - for adding feature specific configuration information
• Post Configuration Activities - describing how to validate the configuration 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/configguide/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 the line

.. include:: ../<my_repo>/docs/configguide/configguide.rst

In the Post Configuration Activities section you would add the line

.. include:: ../<my_repo>/docs/configguide/postinstall.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.