openstack
/
fuel-docs
Code Issues Proposed changes

Merge "Provides minor updates for Fuel Plugin SDK"

This commit is contained in:
Jenkins 2016-11-03 15:30:00 +00:00 committed by Gerrit Code Review
parent 18510ed50a f853a48ee7
commit 54c259fc60
4 changed files with 13 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
plugindocs/fuel-plugin-sdk-guide/create-environment/repository-workflow.rst
View File

@ -12,7 +12,8 @@ As a plugin developer, your repository workflow must be the following:
repository in the OpenStack namespace, you need to do the following: repository in the OpenStack namespace, you need to do the following:
* Have your code reviewed by the `Fuel team <https://bugs.launchpad.net/fuel/>`_. * Have your code reviewed by the `Fuel team <https://bugs.launchpad.net/fuel/>`_.
You can also request a review in the #fuel-dev channel in IRC. You can also request a review in the #fuel-dev channel in IRC. You are welcome
to request peer review from the members of your development team.
* Plan to set up a CI for the plugin. See :ref:`plugin-ci`. * Plan to set up a CI for the plugin. See :ref:`plugin-ci`.
* Confirm that you are going to support the plugin for more than one * Confirm that you are going to support the plugin for more than one
version of Fuel. version of Fuel.

7
plugindocs/fuel-plugin-sdk-guide/existing-plugins.rst
View File

@ -3,5 +3,8 @@
Overview of existing plugins Overview of existing plugins
============================ ============================
* `Fuel plugins on GitHub <https://github.com/search?utf8=%E2%9C%93&q=fuel-plugin+in%3Aname>`_ * `Fuel plugins on GitHub <https://github.com/search?utf8=%E2%9C%93&q=fuel-plugin+in%3Aname>`_ -
* `DriverLog <http://stackalytics.com/report/driverlog?project_id=openstack/fuel>`_ contains the source code of Fuel Plugins.
* `DriverLog <http://stackalytics.com/report/driverlog?project_id=openstack/fuel>`_ -
contains the list of plugin maintainers with their contacts, compatible OpenStack releases,
and the CI/CD pipeline.

9
plugindocs/fuel-plugin-sdk-guide/introduction.rst
View File

@ -10,15 +10,12 @@ The Fuel Plugin SDK Guide provides instructions on how to build, test, and
troubleshoot your plugins; the guide also gives an overview of the existing troubleshoot your plugins; the guide also gives an overview of the existing
plugins. plugins.
This guide focuses on Fuel Plugin Builder Version 4 delivered with Fuel 8.0
Maintenance Update 1.
Before you read this document, you must do the following: Before you read this document, you must do the following:
#. Install Fuel 8.0. See :ref:`fuel-install-guide`. #. Install the latest Fuel version. See :ref:`fuel-install-guide`.
#. Update the Fuel Master node to Maintenance Update 1.
#. Deploy an OpenStack environment with one controller and one compute node. #. Deploy an OpenStack environment with one controller and one compute node.
See :ref:`create-env-ug`. See :ref:`create-env-ug`. For testing purposes you will need to use at
least 3 Controller nodes for high availability.
This guide is a work in progress and will eventually have most of This guide is a work in progress and will eventually have most of
the information you need on Fuel Plugin SDK. In the meantime, use the information you need on Fuel Plugin SDK. In the meantime, use

6
plugindocs/fuel-plugin-sdk-guide/requirements.rst
View File

@ -10,6 +10,6 @@ Requirements
* If you use plugin pre-deployment scripts that somehow change the state of * If you use plugin pre-deployment scripts that somehow change the state of
the Fuel Master node -- for example, changes to Nailgun database -- the Fuel Master node -- for example, changes to Nailgun database --
ensure that all these changes are removed in the post-deployment script. ensure that all these changes are removed in the post-deployment script.
* TBD Fuel code style guidelines * See :ref:`code-style` and
* TBD Use puppet-lint and pep8 (+bash?) `Fuel contribution guidelines <https://wiki.openstack.org/wiki/Fuel/How_to_contribute>`_
* TBD recommendation on pre_build_hook * recommendation on pre_build_hook