From 633150b4bd6b8c5cd93b56f38e6d9c4b443f7dd9 Mon Sep 17 00:00:00 2001 From: Julien Godin Date: Thu, 2 Nov 2023 10:37:30 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=92=9A=20Expand=20the=20summary?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Julien Godin --- manifests/install.pp | 11 ++++++----- manifests/scrape_job.pp | 5 +++-- manifests/unbound_exporter.pp | 5 ++--- 3 files changed, 11 insertions(+), 10 deletions(-) diff --git a/manifests/install.pp b/manifests/install.pp index 739cb43ef..1163dde92 100644 --- a/manifests/install.pp +++ b/manifests/install.pp @@ -1,8 +1,9 @@ -# @summary -# Install prometheus via different methods with parameters from init -# Currently only the install from url is implemented, when Prometheus will deliver packages for some Linux distros I will -# implement the package install method as well -# The package method needs specific yum or apt repo settings which are not made yet by the module +# @summary Install prometheus +# +# @note Install prometheus via different methods with parameters from init +# Currently only the install from url is implemented, when Prometheus will deliver packages for some Linux distros I will +# implement the package install method as well +# The package method needs specific yum or apt repo settings which are not made yet by the module class prometheus::install { assert_private() diff --git a/manifests/scrape_job.pp b/manifests/scrape_job.pp index 106632319..0b7622559 100644 --- a/manifests/scrape_job.pp +++ b/manifests/scrape_job.pp @@ -1,5 +1,6 @@ -# @summary -# This define is used to export prometheus scrape settings from nodes to be scraped to the node +# @summary This module manages prometheus scrape jobs. +# +# @note This define is used to export prometheus scrape settings from nodes to be scraped to the node # running prometheus itself. # This can be used to make prometheus find instances of your running service or application. # @param job_name diff --git a/manifests/unbound_exporter.pp b/manifests/unbound_exporter.pp index 4091afd5e..7f6e4df1c 100644 --- a/manifests/unbound_exporter.pp +++ b/manifests/unbound_exporter.pp @@ -1,6 +1,5 @@ -# -# @summary This module manages prometheus unbound exporter. The exporter needs to be compiled by hand! (https://github.com/kumina/unbound_exporter/issues/21) -# +# @summary This module manages prometheus unbound exporter. +# @note The exporter needs to be compiled by hand! (https://github.com/kumina/unbound_exporter/issues/21) # @param arch # Architecture # @param bin_dir