Update docs as requested by Mirantis

Change-Id: I5725fa1992d6562a5ffb89a6f0897e04e1240277
2016-10-03 16:44:30 +01:00 · 2016-10-03 16:44:30 +01:00 · 5090de8fc6
parent f15c61b0d4
commit 5090de8fc6
8 changed files with 55 additions and 43 deletions
--- a/6
+++ b/6
@ -9,7 +9,7 @@ PLUGIN_REVISION:=$(shell ./get_plugin_version.sh ${BRANDING} | cut -d' ' -f2)
 RPM_NAME=${PLUGIN_NAME}-${PLUGIN_VERSION}-${PLUGIN_VERSION}.${PLUGIN_REVISION}-1.noarch.rpm
 BUILDROOT=BUILD

-DOC_NAMES=user-guide test-plan test-report
+DOC_NAMES=user-guide ${PLUGIN_REVISION}-test-plan ${PLUGIN_REVISION}-test-report

 .SUFFIXES:

@ -58,6 +58,10 @@ output/${RPM_NAME}: ${BUILDROOT}/${PLUGIN_NAME}
 ${BUILDROOT}/doc/build/latex/%.pdf: ${BUILDROOT}/doc/Makefile ${shell find ${BUILDROOT}/doc/source}
 	make -C ${BUILDROOT}/doc latexpdf

+output/${PLUGIN_NAME}-${PLUGIN_VERSION}-${PLUGIN_REVISION}-%.pdf: ${BUILDROOT}/doc/build/latex/%.pdf
+	mkdir -p output
+	cp $^ $@
+
 output/${PLUGIN_NAME}-${PLUGIN_VERSION}-%.pdf: ${BUILDROOT}/doc/build/latex/%.pdf
 	mkdir -p output
 	cp $^ $@
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@ -59,7 +59,7 @@ author = u'John Hua (john.hua@citrix.com)'
 # The short X.Y version.
 version = '@PLUGIN_VERSION@'
 # The full version, including alpha/beta/rc tags.
-release = '@PLUGIN_VERSION@-@PLUGIN_REVISION@'
+release = '@PLUGIN_VERSION@'

 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@ -1,5 +1,5 @@
 Intro
-----
+=====

 This document will guide you through the steps of install, configure and use of the XenServer Plugin for Fuel

--- a/doc/source/installation.rst
+++ b/doc/source/installation.rst
@ -11,16 +11,20 @@ To install the XenServer Fuel plugin:
 #. Copy the *rpm* file to the Fuel Master node:
   ::

-      [root@home ~]# scp fuel-plugin-xenserver-4.0-4.0.0-1.noarch.rpm root@fuel:/tmp
+      [root@home ~]# scp fuel-plugin-xenserver-4.0-4.0.*-1.noarch.rpm root@fuel:/tmp

 #. Log into Fuel Master node and install the plugin using the
   `Fuel CLI <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/cli.html>`_:

   ::

-      [root@fuel-master ~]# fuel plugins --install /tmp/fuel-plugin-xenserver-4.0-4.0.0-1.noarch.rpm
+      [root@fuel-master ~]# fuel plugins --install /tmp/fuel-plugin-xenserver-4.0-4.0.*-1.noarch.rpm
+
+#. Verify that the plugin is installed correctly.  Note that the
+   version displayed may differ in the final part of the version
+   number (the patch level).  All versions with the same major and
+   minor version number are compatible with this guide.

-#. Verify that the plugin is installed correctly:
   ::

     [root@fuel-master ~]# fuel plugins
--- a/doc/source/relnotes.rst
+++ b/doc/source/relnotes.rst
@ -1,39 +1,31 @@
 Release Notes
 =============

-Version 4.0.0
+Version 4.0
 -------------

 * Works with Fuel 9.0

-Version 3.1.2
-------------
-
-* Fix static routes with udev rules
-
-Version 3.1.1
-------------
-
-* Fix image cache
-
-Version 3.1.0
+Version 3.1
 -------------

 * Uses new features of FPB 4.0
 * Uses ssh-key instead of password
+* Fix image cache
+* Fix static routes with udev rules

-Version 3.0.0
+Version 3.0
 -------------

 * Works with Fuel 8.0
 * Add Neutron support

-Version 2.0.0
+Version 2.0
 -------------

 * Works with Fuel 7.0

-Version 1.0.0
+Version 1.0
 -------------

 * Initial release of the plugin.
--- a/doc/source/test-plan.rst
+++ b/doc/source/test-plan.rst
@ -121,15 +121,11 @@ Install XenServer Fuel Plugin
       and the new OpenStack release is registered.
   * - Steps
     -
-       | ``fuel plugins --install /tmp/fuel-plugin-xenserver-4.0-4.0.0-1.noarch.rpm``
-       | ``fuel plugins``
-       | ``id | name                  | version | package_version``
-       | ``1  | fuel-plugin-xenserver | 4.0.0   | 4.0.0``
+       #. Run ``ls /tmp/fuel-plugin-xenserver-4.0-4.0.*-1.noarch.rpm`` to confirm the exact version of fuel plugin to be installed.
+       #. Run ``fuel plugins --install /tmp/<rpm filename>`` to install the plugin
+       #. Run ``fuel plugins`` to list the plugins installed
   * - Expected Result
-     -
-       | ``fuel plugins``
-       | ``id | name                  | version | package_version``
-       | ``1  | fuel-plugin-xenserver | 4.0.0   | 4.0.0``
+     - The table output by Fuel shows the version identified in the first step as installed

 Prepare Nodes
 -------------
@ -411,7 +407,9 @@ Uninstall of plugin with deployed environment
     - Verify XenServer Fuel Plugin cannot be uninstalled before all
       dependant environments are removed.
   * - Steps
-     - ``fuel plugins --remove fuel-plugin-xenserver==4.0.0``
+     -
+       #. Run ``fuel plugins`` to identify the exact version of the plugin installed
+       #. Run ``fuel plugins --remove fuel-plugin-xenserver==<version>`` to remove the plugin
   * - Expected Result
     - 400 Client Error: Bad Request (Can't delete plugin which is enabled
       for some environment.)
@ -430,8 +428,10 @@ Uninstall of plugin
     - Verify XenServer Fuel Plugin can be uninstalled as well as XenServer
       OpenStack release after all dependant environments are removed.
   * - Steps
-     - | ``fuel plugins --remove fuel-plugin-xenserver==4.0.0``
-       | ``fuel plugins``
+     -
+       #. Run ``fuel plugins`` to identify the exact version of the plugin installed
+       #. Run ``fuel plugins --remove fuel-plugin-xenserver==<version>`` to remove the plugin
+       #. Run ``fuel plugins``
   * - Expected Result
     - Plugin is removed.

--- a/doc/source/test-report.rst
+++ b/doc/source/test-report.rst
@ -39,7 +39,7 @@ Document purpose
 ================

 This document provides test run results for the XenServer Fuel Plugin version
-4.0.0 on Mirantis OpenStack 9.0.
+<Complete on branch> on Mirantis OpenStack 9.0.

 Test environment
 ================
@ -67,6 +67,20 @@ verification. For other configuration settings, please see the test plan.
     - 4GB
     - 60GB

+Plugin's RPM
+------------
+
+======================= =========================
+RPM Name                 MD5 Checksum
+======================= =========================
+<Complete on branch>     <Complete on branch>
+======================= =========================
+
+
+Interoperability with other plugins
+-----------------------------------
+No other plugins were tested for interoperability.
+
 Test coverage and metrics
 -------------------------

@ -77,9 +91,6 @@ Test coverage and metrics
 Test results summary
 ====================

-Type of testing
-===============
-
 System Testing
 --------------

@ -160,7 +171,7 @@ Detailed test run results
     -
     - "Update stack actions: inplace, replace and update whole template"
       is failed because vif hot plug/unplug is not supported by the
-       XenServer driver in Mitaka.
+       XenServer driver.
   * - 9
     - Add/Remove compute node
     - Yes
--- a/doc/source/troubleshooting.rst
+++ b/doc/source/troubleshooting.rst
@ -6,13 +6,14 @@ Troubleshooting
   In addition to the Astute log, XenServer Fuel Plugin has its own log under
   /var/log/fuel-plugin-xenserver on all Compute and Controller nodes.

-   Besides HIMN tool mentioned in Installation Guide also has its own log
+   The HIMN tool mentioned in Installation Guide also has its own log
   under ``%LOCALAPPDATA%/Temp/XCHIMN.log``.

-   You can upload issued logs to https://cis.citrix.com or send to support if
-   they are requested. `Writing Good Bug Reports for XenServer`_ might be a
-   good reference to follow.
-
 #. XenServer Bug Reports

-.. _Writing Good Bug Reports for XenServer: https://www.citrix.com/blogs/2012/07/16/writing-good-bug-reports-for-xenserver/
+   You can upload issued logs to https://cis.citrix.com or send to support if
+   they are requested.
+
+   Please see the following blog post for advice on bug reports
+   XenServer: `Writing Good Bug Reports for XenServer
+   <https://www.citrix.com/blogs/2012/07/16/writing-good-bug-reports-for-xenserver/>`_