Files
fuel-docs/pages/plugin-dev/plugin-doc-template.rst
irina povolotskaya dd0dfcb4b7 Creates a new Plugin Development Guide
Since Fuel 6.0 supports Pluggable architecture,
a separate Guide is created to describe the following:

* how to install a plugin
* example plugins
* how to create a plugin
* how plugin UI elements should look like

Links to plug-in-related CRs:

* Certification issue (to be posted to Plug-in DevGuide): https://review.openstack.org/#/c/140421/

* User Guide instructions for installing plug-ins: https://review.openstack.org/#/c/130506/

* Update Terminology articles https://review.openstack.org/#/c/140350/

Change-Id: I78668b7bdc0e1b4f09244146a789bb12c921100c
Closes-Bug: 1397889
2014-12-30 17:59:09 -08:00

835 B

Documentation templates

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

Plug-in User Guide

User Guide must contain the following information:

  1. Full plug-in name with the description and functionality
  2. Requirements, limitations and prerequisites for plug-in usage
  3. Instructions for using already installed plug-in
  4. API usage examples (if required)
  5. UI configuration (if required)

Plug-in Installation Guide

Plug-in Installation Guide must contain the following information:

  1. Full plug-in name with the description and functionality
  2. Requirements, limitations and prerequisites for plug-in installation
  3. Compatibility with a specific Mirantis OpenStack releases
  4. Configuration instructions