From f853a48ee7971939bc36d68583d4fc2ea1e09c47 Mon Sep 17 00:00:00 2001 From: Irina Povolotskaya Date: Mon, 31 Oct 2016 11:31:37 +0300 Subject: [PATCH] Provides minor updates for Fuel Plugin SDK This change focuses on the latest Fuel version (9.x) and the corresponding references. Change-Id: Ic22fa69053896fbe35473545abf9f740952fd709 --- .../create-environment/repository-workflow.rst | 3 ++- plugindocs/fuel-plugin-sdk-guide/existing-plugins.rst | 7 +++++-- plugindocs/fuel-plugin-sdk-guide/introduction.rst | 9 +++------ plugindocs/fuel-plugin-sdk-guide/requirements.rst | 6 +++--- 4 files changed, 13 insertions(+), 12 deletions(-) diff --git a/plugindocs/fuel-plugin-sdk-guide/create-environment/repository-workflow.rst b/plugindocs/fuel-plugin-sdk-guide/create-environment/repository-workflow.rst index 54686c4e8..165aec5ae 100644 --- a/plugindocs/fuel-plugin-sdk-guide/create-environment/repository-workflow.rst +++ b/plugindocs/fuel-plugin-sdk-guide/create-environment/repository-workflow.rst @@ -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: * Have your code reviewed by the `Fuel team `_. - 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`. * Confirm that you are going to support the plugin for more than one version of Fuel. diff --git a/plugindocs/fuel-plugin-sdk-guide/existing-plugins.rst b/plugindocs/fuel-plugin-sdk-guide/existing-plugins.rst index b71e53538..feb006370 100644 --- a/plugindocs/fuel-plugin-sdk-guide/existing-plugins.rst +++ b/plugindocs/fuel-plugin-sdk-guide/existing-plugins.rst @@ -3,5 +3,8 @@ Overview of existing plugins ============================ -* `Fuel plugins on GitHub `_ -* `DriverLog `_ \ No newline at end of file +* `Fuel plugins on GitHub `_ - + contains the source code of Fuel Plugins. +* `DriverLog `_ - + contains the list of plugin maintainers with their contacts, compatible OpenStack releases, + and the CI/CD pipeline. \ No newline at end of file diff --git a/plugindocs/fuel-plugin-sdk-guide/introduction.rst b/plugindocs/fuel-plugin-sdk-guide/introduction.rst index 0e8187d85..df655af88 100644 --- a/plugindocs/fuel-plugin-sdk-guide/introduction.rst +++ b/plugindocs/fuel-plugin-sdk-guide/introduction.rst @@ -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 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: -#. Install Fuel 8.0. See :ref:`fuel-install-guide`. -#. Update the Fuel Master node to Maintenance Update 1. +#. Install the latest Fuel version. See :ref:`fuel-install-guide`. #. 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 the information you need on Fuel Plugin SDK. In the meantime, use diff --git a/plugindocs/fuel-plugin-sdk-guide/requirements.rst b/plugindocs/fuel-plugin-sdk-guide/requirements.rst index e7073a2eb..df03f8abf 100644 --- a/plugindocs/fuel-plugin-sdk-guide/requirements.rst +++ b/plugindocs/fuel-plugin-sdk-guide/requirements.rst @@ -10,6 +10,6 @@ Requirements * If you use plugin pre-deployment scripts that somehow change the state of the Fuel Master node -- for example, changes to Nailgun database -- ensure that all these changes are removed in the post-deployment script. -* TBD Fuel code style guidelines -* TBD Use puppet-lint and pep8 (+bash?) -* TBD recommendation on pre_build_hook \ No newline at end of file +* See :ref:`code-style` and + `Fuel contribution guidelines `_ +* recommendation on pre_build_hook \ No newline at end of file