Skip to content

Commit 40dd6ef

Browse files
docs(readme): fix formatting
1 parent e9c3aaa commit 40dd6ef

File tree

1 file changed

+33
-33
lines changed

1 file changed

+33
-33
lines changed

docs/README.rst

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,11 @@ iscsi-formula
1313
:alt: Semantic Release
1414
:scale: 100%
1515
:target: https://github.com/semantic-release/semantic-release
16-
17-
Manage iSCSI Targets, Initiators, Name-Services on GNU/Linux and FreeBSD.
16+
17+
Configure iSCSI targets and initiator on GNU/Linux and FreeBSD.
1818

1919
.. contents:: **Table of Contents**
20+
:depth: 1
2021

2122
General notes
2223
-------------
@@ -41,28 +42,27 @@ Please see :ref:`How to contribute <CONTRIBUTING>` for more details.
4142

4243
Scope
4344
-----
44-
.. image:: docs/link-transport-storage-protocols.png
45+
.. image:: link-transport-storage-protocols.png
4546
:target: https://github.com/saltstack-formulas/iscsi-formula
46-
:scale: 25 %
47+
:scale: 15 %
4748
:alt: Link/Transport and Storage protocol infographic
4849

4950
Available Meta states
50-
======================
51+
---------------------
5152

5253
.. contents::
5354
:local:
5455

5556
``iscsi``
56-
^^^^^^^^^^^^
57-
57+
^^^^^^^^^
5858
*Meta-state (This is a state that includes other states)*.
5959

6060
Deploy iSNS, iSCSI initiator, and iSCSI target
6161
packages, manage configuration files and then
6262
starts the associated iscsi services.
6363

6464
``iscsi.target``
65-
----------------
65+
^^^^^^^^^^^^^^^^
6666
Install and configure the iSCSI Target service. Supported vendor implementations include-
6767

6868
- ``/etc/ctl.conf`` for ``ctld(8)`` on FreeBSD
@@ -81,7 +81,7 @@ The default choice is modifable via the `iscsi.target.provider` pillar value.
8181
New providers can be introduced via pull request.
8282

8383
``iscsi.target.clean``
84-
----------------------
84+
^^^^^^^^^^^^^^^^^^^^^^
8585
*Meta-state (This is a state that includes other states)*.
8686

8787
this state will undo everything performed in the ``iscsi.target`` meta-state
@@ -91,14 +91,14 @@ removes the configuration files and
9191
then uninstalls the package.
9292

9393
``iscsi.initiator``
94-
------------------
94+
^^^^^^^^^^^^^^^^^^^
9595
Install and configure the iSCSI initiator service-
9696

9797
- ``/etc/iscsi.conf`` for FreeBSD
9898
- ``/etc/iscsi/iscsid.conf`` or ``~/.iscsid.conf`` for ``Open iSCSI`` on GNU/Linux
9999

100100
``iscsi.initiator.clean``
101-
-------------------------
101+
^^^^^^^^^^^^^^^^^^^^^^^^^
102102
*Meta-state (This is a state that includes other states)*.
103103

104104
this state will undo everything performed in the ``iscsi.initiator``
@@ -112,7 +112,7 @@ then uninstalls the package.
112112
Install and configure iSCSI name service.
113113

114114
``iscsi.isns.clean``
115-
--------------------
115+
^^^^^^^^^^^^^^^^^^^^
116116
*Meta-state (This is a state that includes other states)*.
117117

118118
this state will undo everything performed in the ``iscsi.isns``
@@ -123,89 +123,89 @@ then uninstalls the package.
123123

124124

125125
Available sub-states
126-
---------------------
126+
--------------------
127127

128128
.. contents::
129129
:local:
130130

131131
``iscsi.target.package``
132-
------------------------
132+
^^^^^^^^^^^^^^^^^^^^^^^^
133133
Install iSCSI target related packages.
134134

135135
``iscsi.target.package.clean``
136-
------------------------------
136+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
137137
Remove iSCSI target related packages.
138138

139139
``iscsi.target.config``
140-
-----------------------
140+
^^^^^^^^^^^^^^^^^^^^^^^
141141
Install iSCSI target related configuration files.
142142

143143
``iscsi.target.config.clean``
144-
------------------------------
144+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
145145
Remove iSCSI target related configuration files.
146146

147147
``iscsi.target.kernel``
148-
-----------------------
148+
^^^^^^^^^^^^^^^^^^^^^^^
149149
Load iSCSI target related kernel modules.
150150

151151
``iscsi.target.kernel.clean``
152-
-----------------------------
152+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
153153
Unload iSCSI target related kernel modules.
154154

155155
``iscsi.target.make``
156-
---------------------
156+
^^^^^^^^^^^^^^^^^^^^^
157157
Make iSCSI related packages from git source on FreeBSD.
158158

159159
``iscsi.target.make.clean``
160-
---------------------------
160+
^^^^^^^^^^^^^^^^^^^^^^^^^^^
161161
Remove iSCSI related package binaries on FreeBSD.
162162

163163
``iscsi.target.service``
164-
------------------------
164+
^^^^^^^^^^^^^^^^^^^^^^^^
165165
Install iSCSI target services.
166166

167167
``iscsi.target.service.clean``
168-
-----------------------------
168+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
169169
Stop and disable SCSI target services.
170170

171171
``iscsi.initiator.package``
172-
---------------------------
172+
^^^^^^^^^^^^^^^^^^^^^^^^^^^
173173
Install iSCSI initiator related packages.
174174

175175
``iscsi.initiator.package.clean``
176-
---------------------------------
176+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
177177
Remove iSCSI initiator related packages.
178178

179179
``iscsi.initiator.config``
180-
--------------------------
180+
^^^^^^^^^^^^^^^^^^^^^^^^^^
181181
Install iSCSI initiator related configuration files.
182182

183183
``iscsi.initiator.config.clean``
184-
--------------------------------
184+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
185185
Remove iSCSI initiator related configuration files.
186186

187187
``iscsi.initiator.kernel``
188-
--------------------------
188+
^^^^^^^^^^^^^^^^^^^^^^^^^^
189189
Load iSCSI initiator related kernel modules.
190190

191191
``iscsi.initiator.kernel.clean``
192-
--------------------------------
192+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
193193
Unload iSCSI initiator related kernel modules.
194194

195195
``iscsi.initiator.make``
196-
------------------------
196+
^^^^^^^^^^^^^^^^^^^^^^^^
197197
Make iSCSI related packages from git source for FreeBSD.
198198

199199
``iscsi.initiator.make.clean``
200-
------------------------------
200+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
201201
Remove iSCSI related package binaries on FreeBSD.
202202

203203
``iscsi.initiator.service``
204-
---------------------------
204+
^^^^^^^^^^^^^^^^^^^^^^^^^^^
205205
Install iSCSI initiator services.
206206

207207
``iscsi.initiator.service.clean``
208-
---------------------------------
208+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
209209
Stop and disable iSCSI initiator services.
210210

211211
``iscsi.isns.package``

0 commit comments

Comments
 (0)