Merge pull request #27 from noelmcloughlin/readme

docs(readme): fix formatting

Author: noelmcloughlin

docs/README.rst

@@ -13,10 +13,11 @@ iscsi-formula
    :alt: Semantic Release
    :scale: 100%
    :target: https://github.com/semantic-release/semantic-release
-
-Manage iSCSI Targets, Initiators, Name-Services on GNU/Linux and FreeBSD.
+   
+Configure iSCSI targets and initiator on GNU/Linux and FreeBSD.
 
 .. contents:: **Table of Contents**
+   :depth: 1
 
 General notes
 -------------
@@ -41,28 +42,27 @@ Please see :ref:`How to contribute <CONTRIBUTING>` for more details.
 
 Scope
 -----
-.. image:: docs/link-transport-storage-protocols.png
+.. image:: link-transport-storage-protocols.png
    :target: https://github.com/saltstack-formulas/iscsi-formula
-   :scale: 25 %
+   :scale: 15 %
    :alt: Link/Transport and Storage protocol infographic
 
 Available Meta states
-======================
+---------------------
 
 .. contents::
     :local:
 
 ``iscsi``
-^^^^^^^^^^^^
-
+^^^^^^^^^
 *Meta-state (This is a state that includes other states)*.
 
 Deploy iSNS, iSCSI initiator, and iSCSI target
 packages, manage configuration files and then
 starts the associated iscsi services.
 
 ``iscsi.target``
-----------------
+^^^^^^^^^^^^^^^^
 Install and configure the iSCSI Target service. Supported vendor implementations include-
 
 - ``/etc/ctl.conf`` for ``ctld(8)`` on FreeBSD
@@ -81,7 +81,7 @@ The default choice is modifable via the `iscsi.target.provider` pillar value.
 New providers can be introduced via pull request.
 
 ``iscsi.target.clean``
-----------------------
+^^^^^^^^^^^^^^^^^^^^^^
 *Meta-state (This is a state that includes other states)*.
 
 this state will undo everything performed in the ``iscsi.target`` meta-state
@@ -91,14 +91,14 @@ removes the configuration files and
 then uninstalls the package.
 
 ``iscsi.initiator``
-------------------
+^^^^^^^^^^^^^^^^^^^
 Install and configure the iSCSI initiator service-
 
 - ``/etc/iscsi.conf`` for FreeBSD
 - ``/etc/iscsi/iscsid.conf`` or ``~/.iscsid.conf`` for ``Open iSCSI`` on GNU/Linux
 
 ``iscsi.initiator.clean``
--------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^
 *Meta-state (This is a state that includes other states)*.
 
 this state will undo everything performed in the ``iscsi.initiator``
@@ -112,7 +112,7 @@ then uninstalls the package.
 Install and configure iSCSI name service.
 
 ``iscsi.isns.clean``
---------------------
+^^^^^^^^^^^^^^^^^^^^
 *Meta-state (This is a state that includes other states)*.
 
 this state will undo everything performed in the ``iscsi.isns``
@@ -123,89 +123,89 @@ then uninstalls the package.
 
 
 Available sub-states
----------------------
+--------------------
 
 .. contents::
    :local:
 
 ``iscsi.target.package``
-------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^
 Install iSCSI target related packages.
 
 ``iscsi.target.package.clean``
-------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Remove iSCSI target related packages.
 
 ``iscsi.target.config``
------------------------
+^^^^^^^^^^^^^^^^^^^^^^^
 Install iSCSI target related configuration files.
 
 ``iscsi.target.config.clean``
-------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Remove iSCSI target related configuration files.
 
 ``iscsi.target.kernel``
------------------------
+^^^^^^^^^^^^^^^^^^^^^^^
 Load iSCSI target related kernel modules.
 
 ``iscsi.target.kernel.clean``
------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Unload iSCSI target related kernel modules.
 
 ``iscsi.target.make``
----------------------
+^^^^^^^^^^^^^^^^^^^^^
 Make iSCSI related packages from git source on FreeBSD.
 
 ``iscsi.target.make.clean``
----------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Remove iSCSI related package binaries on FreeBSD.
 
 ``iscsi.target.service``
-------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^
 Install iSCSI target services.
 
 ``iscsi.target.service.clean``
------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Stop and disable SCSI target services.
 
 ``iscsi.initiator.package``
----------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Install iSCSI initiator related packages.
 
 ``iscsi.initiator.package.clean``
----------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Remove iSCSI initiator related packages.
 
 ``iscsi.initiator.config``
---------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^
 Install iSCSI initiator related configuration files.
 
 ``iscsi.initiator.config.clean``
---------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Remove iSCSI initiator related configuration files.
 
 ``iscsi.initiator.kernel``
---------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^
 Load iSCSI initiator related kernel modules.
 
 ``iscsi.initiator.kernel.clean``
---------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Unload iSCSI initiator related kernel modules.
 
 ``iscsi.initiator.make``
-------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^
 Make iSCSI related packages from git source for FreeBSD.
 
 ``iscsi.initiator.make.clean``
-------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Remove iSCSI related package binaries on FreeBSD.
 
 ``iscsi.initiator.service``
----------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Install iSCSI initiator services.
 
 ``iscsi.initiator.service.clean``
----------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Stop and disable iSCSI initiator services.
 
 ``iscsi.isns.package``