Skip to content

Commit b0021eb

Browse files
committed
docs(readme): fix headings and links [skip ci]
1 parent e443838 commit b0021eb

1 file changed

Lines changed: 10 additions & 13 deletions

File tree

docs/README.rst

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
.. _readme:
2-
31
docker-formula
42
==============
53

@@ -47,10 +45,10 @@ Contributing to this repo
4745

4846
**Commit message formatting is significant!!**
4947

50-
Please see :ref:`How to contribute <CONTRIBUTING>` for more details.
48+
Please see `How to contribute <https://github.com/saltstack-formulas/.github/blob/master/CONTRIBUTING.rst>`_ for more details.
5149

5250
Available Meta states
53-
----------------------
51+
---------------------
5452

5553
.. contents::
5654
:local:
@@ -90,8 +88,8 @@ This state installs Docker (see https://docs.docker.com/engine/install and https
9088

9189
This state installs Dockerd daemon on Linux (systemd support).
9290

93-
``docker.software.service``
94-
^^^^^^^^^^^^^^^^^^^^^^^^^^^
91+
``docker.software.service.clean``
92+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
9593

9694
This state stops Dockerd daemon on Linux (systemd support).
9795

@@ -233,7 +231,7 @@ Saltstack `swarm module` state support (See https://docs.saltstack.com/en/latest
233231
Opposite of `docker.swarm` state (See https://docs.saltstack.com/en/latest/ref/modules/all/salt.modules.swarm.html).
234232

235233
``docker.networks``
236-
^^^^^^^^^^^^^^^^^^
234+
^^^^^^^^^^^^^^^^^^^
237235

238236
Create docker networks
239237

@@ -270,27 +268,26 @@ Where ``[platform]`` is the platform name defined in ``kitchen.yml``,
270268
e.g. ``debian-9-2019-2-py3``.
271269

272270
``bin/kitchen converge``
273-
^^^^^^^^^^^^^^^^^^^^
271+
^^^^^^^^^^^^^^^^^^^^^^^^
274272

275273
Creates the Docker instance and runs the ``docker`` main state, ready for testing.
276274

277275
``bin/kitchen verify``
278-
^^^^^^^^^^^^^^^^^^
276+
^^^^^^^^^^^^^^^^^^^^^^
279277

280278
Runs the ``inspec`` tests on the actual instance.
281279

282280
``bin/kitchen destroy``
283-
^^^^^^^^^^^^^^^^^^^
281+
^^^^^^^^^^^^^^^^^^^^^^^
284282

285283
Removes the Docker instance.
286284

287285
``bin/kitchen test``
288-
^^^^^^^^^^^^^^^^
286+
^^^^^^^^^^^^^^^^^^^^
289287

290288
Runs all of the stages above in one go: i.e. ``destroy`` + ``converge`` + ``verify`` + ``destroy``.
291289

292290
``bin/kitchen login``
293-
^^^^^^^^^^^^^^^^^
291+
^^^^^^^^^^^^^^^^^^^^^
294292

295293
Gives you SSH access to the instance for manual testing.
296-

0 commit comments

Comments
 (0)