From 6e6a71cc206ad4d32fa324dc624e9c872513d8c2 Mon Sep 17 00:00:00 2001
From: Irina Povolotskaya <ipovolotskaya@mirantis.com>
Date: Fri, 13 Feb 2015 13:09:59 +0300
Subject: [PATCH] Adds information into plugin spec and readme file

This commit provides the following changes:

* edited spec with emails of plugin contributors

* edited README.md file with fixed instructions on installation

Change-Id: I4d81ebc45874d04aab86007eeaf77d3a9bb536a9
---
 README.md                   | 41 +++++++++++++++++++++++++++----------
 specs/fuel-plugin-fwaas.rst | 23 ++++++++++++---------
 2 files changed, 43 insertions(+), 21 deletions(-)

diff --git a/README.md b/README.md
index 2ce6c2c..6d74c56 100644
--- a/README.md
+++ b/README.md
@@ -8,14 +8,33 @@ Currently the only supported Fuel version is 6.0.
 
 Building the plugin
 -------------------
-1. Clone the fuel-plugins repo from https://github.com/stackforge/fuel-plugins
-2. Install Fuel Plugin Builder using documentation from the fuel-plugins repo
-3. Execute fpb --build <path>, where <path> is the path to the plugin's main
-   folder (fwaas)
-4. fwaas-plugin-1.0.0.fp plugin file will be created
-5. Move this file to the Fuel master node and install it using
-   the following command: fuel plugins --install fwaas-plugin-1.0.0.fp
-6. Plugin is ready to use and can be enabled via Fuel WebUI ('Settings' tab)
+
+1. Clone the FWaaS plugin repo from `https://github.com/stackforge/fuel-plugin-neutron-fwaas`.
+2. Install Fuel Plugin Builder:
+
+    ``pip install fuel-plugin-builder``
+
+3. Execute ``fpb --build <path>`` command, where <path> is the path to the plugin's main
+   folder (fwaas). For example:
+
+   ``fpb --build fuel-plugin-neutron-fwaas/
+
+4. The fwaas-plugin-1.0.0.fp plugin file will be created.
+
+5. Move this file to the Fuel Master node with secure copy (scp):
+
+	``scp fwaas-plugin-1.0.0.fp root@:<the_Fuel_Master_node_IP address>:/tmp``
+   ``cd /tmp``
+
+6. Install it using the following command:
+
+	``fuel plugins --install fwaas-plugin-1.0.0.fp``
+
+6. Plugin is ready to use and can be enabled on the Settings tab of the Fuel web UI.
+
+Note that you can also download the built FWaaS
+plugin from
+the [Fuel Plugins Catalog](https://software.mirantis.com/download-mirantis-openstack-fuel-plug-ins/).
 
 Deployment details
 ------------------
@@ -23,11 +42,11 @@ Deployment details
 FWaaS deployment requires only adding a couple parameters in neutron.conf and
 enabling FWaaS tab in Horizon.
 
-
 Accessing FWaaS functionality
 ------------------------------
-Firewall settings can be found in Openstack Dashboard:
-Project -> Network -> Firewall
+
+Firewall settings can be found on the Openstack Dashboard (Horizon) in
+Project -> Network -> Firewall.
 
 Please use official Openstack documentation to obtain more information:
 - http://docs.openstack.org/admin-guide-cloud/content/install_neutron-fwaas-agent.html
diff --git a/specs/fuel-plugin-fwaas.rst b/specs/fuel-plugin-fwaas.rst
index b604a0d..466eba3 100644
--- a/specs/fuel-plugin-fwaas.rst
+++ b/specs/fuel-plugin-fwaas.rst
@@ -88,17 +88,20 @@ Assignee(s)
 -----------
 
 Primary assignee:
+    Andrey Epifanov <aepifanov@mirantis.com> - feature lead, developer
 
-Feature Lead: Andrey Epifanov
-Mandatory Design Reviewers: Stanislaw Bogatkin, Sergey Kolekonov,
-Sergey Vasilenko
-Developers: Andrey Epifanov
-QA: Timur Nurlygayanov
+Other contrubitors:
+
+    Stanislaw Bogatkin <sbogatkin@mirantis.com> - design reviewer
+    Sergey Kolekonov <skilekonov@mirantis.com> - design reviewer
+    Timur Nurlygayanov <tnurlygayanov@mirantis.com> - QA engineer
+    Kristina Kuznetsova <kkuznetsova@mirantis.com> - QA engineer
+    Irina Povolotskaya <ipovolotskaya@mirantis.com> - technical writer
 
 Work Items
 ----------
 
-* Implement FUEL plugin.
+* Implement Fuel plugin.
 * Implement puppet manifests.
 * Testing.
 * Write documentation.
@@ -106,16 +109,16 @@ Work Items
 Dependencies
 ============
 
-* FUEL 6.0 and higher.
+* Fuel 6.0 and higher.
 
 Testing
 =======
 
 * Prepare a test plan.
 * Test deployment with activated plugin for all FUEL deployment modes.
-* Test FWaaS functionality as well:
-  https://wiki.openstack.org/wiki/Quantum/FWaaS/Testing
-* Integration tests with other OpenStack components and Neutron plugins.
+* Test FWaaS functionality as well according to the `FWaaS Testing
+  <https://wiki.openstack.org/wiki/Quantum/FWaaS/Testing>`_.
+* Provide integration tests with other OpenStack components and Neutron plugins.
 
 Documentation Impact
 ====================