Skip to content

Commit

Permalink
docs(readme): update heading markers for consistency
Browse files Browse the repository at this point in the history
  • Loading branch information
myii committed Mar 1, 2019
1 parent 9397bdf commit 5a2bea8
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions docs/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ start on a new formula and it serves as a style guide.
.. contents:: **Table of Contents**

General notes
=============
-------------

See the full `SaltStack Formulas installation and usage instructions
<https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html>`_.
Expand All @@ -29,21 +29,21 @@ See `Formula Versioning Section <https://docs.saltstack.com/en/latest/topics/dev


Contributing to this repo
=========================
-------------------------

**Commit message formatting is significant!!**

Please see `CONTRIBUTING <CONTRIBUTING.rst>`_ for more details.


Available states
================
----------------

.. contents::
:local:

``template``
------------
^^^^^^^^^^^^

Meta-state (This is a state that includes other states)

Expand All @@ -52,24 +52,24 @@ manages the template configuration file and then
starts the associated template service.

``template.package``
--------------------
^^^^^^^^^^^^^^^^^^^^

This state will install the template package only.

``template.config``
-------------------
^^^^^^^^^^^^^^^^^^^

This state will configure the template service and has a dependency on ``template.install``
via include list.

``template.service``
--------------------
^^^^^^^^^^^^^^^^^^^^

This state will start the template service and has a dependency on ``template.config``
via include list.

``template.clean``
------------------
^^^^^^^^^^^^^^^^^^

Meta-state (This is a state that includes other states)

Expand All @@ -79,18 +79,18 @@ removes the configuration file and
then uninstalls the package.

``template.service.clean``
--------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^

This state will stop the template service and disable it at boot time.

``template.config.clean``
-------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^

This state will remove the configuration of the template service and has a dependency on ``template.service.clean``
via include list.

``template.package.clean``
--------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^

This state will remove the template package and has a depency on ``template.config.clean``
via include list.
Expand Down

0 comments on commit 5a2bea8

Please sign in to comment.