dd0dfcb4b7
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
36 lines
835 B
ReStructuredText
36 lines
835 B
ReStructuredText
.. _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
|