Browse Source

Merge "Provides minor updates for Fuel Plugin SDK"

Jenkins 2 years ago
parent
commit
54c259fc60

+ 2
- 1
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:
12 12
    repository in the OpenStack namespace, you need to do the following:
13 13
 
14 14
    * Have your code reviewed by the `Fuel team <https://bugs.launchpad.net/fuel/>`_.
15
-     You can also request a review in the #fuel-dev channel in IRC.
15
+     You can also request a review in the #fuel-dev channel in IRC. You are welcome
16
+     to request peer review from the members of your development team.
16 17
    * Plan to set up a CI for the plugin. See :ref:`plugin-ci`.
17 18
    * Confirm that you are going to support the plugin for more than one
18 19
      version of Fuel.

+ 5
- 2
plugindocs/fuel-plugin-sdk-guide/existing-plugins.rst View File

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

+ 3
- 6
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
10 10
 troubleshoot your plugins; the guide also gives an overview of the existing
11 11
 plugins.
12 12
 
13
-This guide focuses on Fuel Plugin Builder Version 4 delivered with Fuel 8.0
14
-Maintenance Update 1.
15
-
16 13
 Before you read this document, you must do the following:
17 14
 
18
-#. Install Fuel 8.0. See :ref:`fuel-install-guide`.
19
-#. Update the Fuel Master node to Maintenance Update 1.
15
+#. Install the latest Fuel version. See :ref:`fuel-install-guide`.
20 16
 #. Deploy an OpenStack environment with one controller and one compute node.
21
-   See :ref:`create-env-ug`.
17
+   See :ref:`create-env-ug`. For testing purposes you will need to use at
18
+   least 3 Controller nodes for high availability.
22 19
 
23 20
 This guide is a work in progress and will eventually have most of
24 21
 the information you need on Fuel Plugin SDK. In the meantime, use

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

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

Loading…
Cancel
Save