Skip to content

Commit

Permalink
docs(readme): fix headings and contributing link [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
myii committed May 5, 2021
1 parent a9e26a7 commit bb7b816
Showing 1 changed file with 14 additions and 16 deletions.
30 changes: 14 additions & 16 deletions docs/README.rst
@@ -1,5 +1,3 @@
.. _readme:

prometheus-formula
==================

Expand Down Expand Up @@ -37,7 +35,7 @@ Contributing to this repo

**Commit message formatting is significant!!**

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

Available metastates
--------------------
Expand All @@ -46,70 +44,70 @@ Available metastates
:local:

``prometheus``
^^^^^^^^^^^^
^^^^^^^^^^^^^^

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

This installs from prometheus solution.


``prometheus.archive``
^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^

This state will install prometheus components on MacOS and GNU/Linux from archive.

``prometheus.clientlibs``
^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^

This state will install prometheus client libraries on MacOS and GNU/Linux from archive.

``prometheus.package``
^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^

This state will install prometheus component packages from GNU/Linux.

``prometheus.config``
^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^

This state will apply prometheus service configuration (files).

``prometheus.service``
^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^

This state will start prometheus component services.

``prometheus.exporters``
^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^

This state will apply prometheus exporters configuration.

``prometheus.exporters.clean``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

This state will remove prometheus exporters configuration.

``prometheus.service.clean``
^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

This state will stop prometheus component services.

``prometheus.config.clean``
^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^^^

This state will remove prometheus service configuration (files).

``prometheus.package.clean``
^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

This state will uninstall prometheus component packages from GNU/Linux.

``prometheus.clientlibs.clean``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

This state will uninstall prometheus client libraries.

``prometheus.archive.clean``
^^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

This state will remove prometheus component archive (directories).

Expand Down

0 comments on commit bb7b816

Please sign in to comment.