saltstack-formulas/prometheus-formula
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(readme): fix headings and contributing link [skip ci]

Browse Source
This commit is contained in:
Imran Iqbal 2021-05-05 15:21:09 +01:00
parent a9e26a795d
commit bb7b816aac
No known key found for this signature in database
GPG Key ID: 6D8629439D2B7819
1 changed files with 14 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs/README.rst
View File

@ -1,5 +1,3 @@
.. _readme:
prometheus-formula prometheus-formula
================== ==================
@ -37,7 +35,7 @@ Contributing to this repo
**Commit message formatting is significant!!** **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 Available metastates
-------------------- --------------------
@ -46,7 +44,7 @@ Available metastates
:local: :local:
``prometheus`` ``prometheus``
^^^^^^^^^^^^ ^^^^^^^^^^^^^^
*Meta-state (This is a state that includes other states)*. *Meta-state (This is a state that includes other states)*.
@ -54,62 +52,62 @@ This installs from prometheus solution.
``prometheus.archive`` ``prometheus.archive``
^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^
This state will install prometheus components on MacOS and GNU/Linux from archive. This state will install prometheus components on MacOS and GNU/Linux from archive.
``prometheus.clientlibs`` ``prometheus.clientlibs``
^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^
This state will install prometheus client libraries on MacOS and GNU/Linux from archive. This state will install prometheus client libraries on MacOS and GNU/Linux from archive.
``prometheus.package`` ``prometheus.package``
^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^
This state will install prometheus component packages from GNU/Linux. This state will install prometheus component packages from GNU/Linux.
``prometheus.config`` ``prometheus.config``
^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^
This state will apply prometheus service configuration (files). This state will apply prometheus service configuration (files).
``prometheus.service`` ``prometheus.service``
^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^
This state will start prometheus component services. This state will start prometheus component services.
``prometheus.exporters`` ``prometheus.exporters``
^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^
This state will apply prometheus exporters configuration. This state will apply prometheus exporters configuration.
``prometheus.exporters.clean`` ``prometheus.exporters.clean``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This state will remove prometheus exporters configuration. This state will remove prometheus exporters configuration.
``prometheus.service.clean`` ``prometheus.service.clean``
^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This state will stop prometheus component services. This state will stop prometheus component services.
``prometheus.config.clean`` ``prometheus.config.clean``
^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^
This state will remove prometheus service configuration (files). This state will remove prometheus service configuration (files).
``prometheus.package.clean`` ``prometheus.package.clean``
^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This state will uninstall prometheus component packages from GNU/Linux. This state will uninstall prometheus component packages from GNU/Linux.
``prometheus.clientlibs.clean`` ``prometheus.clientlibs.clean``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This state will uninstall prometheus client libraries. This state will uninstall prometheus client libraries.
``prometheus.archive.clean`` ``prometheus.archive.clean``
^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This state will remove prometheus component archive (directories). This state will remove prometheus component archive (directories).