.. _plugin-doc-template:

Documentation templates
-----------------------

Fuel plug-in developer must provide Installation and User Guides.

Plug-in User Guide
++++++++++++++++++

User Guide must contain the following information:

#. Full plug-in name with the description and functionality

#. Requirements, limitations and prerequisites for plug-in usage

#. Instructions for using already installed plug-in

#. API usage examples (if required)

#. UI configuration (if required)


Plug-in Installation Guide
++++++++++++++++++++++++++

Plug-in Installation Guide must contain the following information:

#. Full plug-in name with the description and functionality

#. Requirements, limitations and prerequisites for plug-in installation

#. Compatibility with a specific Mirantis OpenStack releases

#. Configuration instructions