From bb7b816aac6d21b85d0dbb20ed894c7f6a8ca941 Mon Sep 17 00:00:00 2001 From: Imran Iqbal Date: Wed, 5 May 2021 15:21:09 +0100 Subject: [PATCH] docs(readme): fix headings and contributing link [skip ci] --- docs/README.rst | 30 ++++++++++++++---------------- 1 file changed, 14 insertions(+), 16 deletions(-) diff --git a/docs/README.rst b/docs/README.rst index 4e6e13f..150f19c 100644 --- a/docs/README.rst +++ b/docs/README.rst @@ -1,5 +1,3 @@ -.. _readme: - prometheus-formula ================== @@ -37,7 +35,7 @@ Contributing to this repo **Commit message formatting is significant!!** -Please see :ref:`How to contribute ` for more details. +Please see `How to contribute `_ for more details. Available metastates -------------------- @@ -46,7 +44,7 @@ Available metastates :local: ``prometheus`` -^^^^^^^^^^^^ +^^^^^^^^^^^^^^ *Meta-state (This is a state that includes other states)*. @@ -54,62 +52,62 @@ 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).