feat: added a small bash script to generate doc for few enableit module

Author: ashish1099

.gitignore

@@ -26,3 +26,6 @@ modules/upstream/.tmp/
 # Ignore keys dir, so one can have keys in local repo
 .keys/
 var/
+
+# Ignore yardoc dir
+*.yardoc/

bin/generate_doc_enableit_module.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+# Generate docs for these modules
+MODULES="common monitor role profile"
+MODULEDIR="modules/enableit"
+
+# Check if puppet-strings is available
+if ! puppet strings --help >/dev/null 2>&1; then
+  log "ERROR: puppet strings command not found. Please install puppet-strings gem."
+  exit 1
+fi
+
+for module in $MODULES; do
+  echo "Processing module: $module"
+
+  MODULEPATH="${MODULEDIR}/${module}"
+  if [ -d "${MODULEPATH}" ]; then
+    puppet strings generate --format markdown --out "${MODULEPATH}/REFERENCE.md" "${MODULEPATH}/manifests/*"
+  fi
+done

modules/enableit/monitor/REFERENCE.md

@@ -0,0 +1,225 @@
+# Reference
+
+<!-- DO NOT EDIT: This document was generated by Puppet Strings -->
+
+## Table of Contents
+
+### Classes
+
+* [`monitor`](#monitor): Class for Obmondo monitoring
+* [`monitor::prometheus`](#monitor--prometheus): Class for managing Prometheus monitoring
+* [`monitor::raid`](#monitor--raid): Class for Raid Monitoring
+* [`monitor::service`](#monitor--service): Class for Obmondo system monitoring
+* [`monitor::system`](#monitor--system): Class for managing the Obmondo system monitoring
+
+### Defined types
+
+* [`monitor::alert`](#monitor--alert): Prometheus monitoring alert
+* [`monitor::domains`](#monitor--domains): Class for managing monitoring of domains and certificate expiry
+* [`monitor::threshold`](#monitor--threshold): Class for defining Prometheus monitoring thresholds
+
+## Classes
+
+### <a name="monitor"></a>`monitor`
+
+Class for Obmondo monitoring
+
+#### Parameters
+
+The following parameters are available in the `monitor` class:
+
+* [`enable`](#-monitor--enable)
+* [`noop_value`](#-monitor--noop_value)
+
+##### <a name="-monitor--enable"></a>`enable`
+
+Data type: `Boolean`
+
+Enable or disable the monitoring. Defaults to the value of $::obmondo_monitoring_status.
+
+Default value: `$::obmondo_monitoring_status`
+
+##### <a name="-monitor--noop_value"></a>`noop_value`
+
+Data type: `Boolean`
+
+No-operation mode value. Defaults to false.
+
+Default value: `false`
+
+### <a name="monitor--prometheus"></a>`monitor::prometheus`
+
+Class for managing Prometheus monitoring
+
+#### Parameters
+
+The following parameters are available in the `monitor::prometheus` class:
+
+* [`enable`](#-monitor--prometheus--enable)
+
+##### <a name="-monitor--prometheus--enable"></a>`enable`
+
+Data type: `Boolean`
+
+Whether to enable the Prometheus monitoring. Defaults to true.
+
+Default value: `true`
+
+### <a name="monitor--raid"></a>`monitor::raid`
+
+Class for Raid Monitoring
+
+### <a name="monitor--service"></a>`monitor::service`
+
+Class for Obmondo system monitoring
+
+### <a name="monitor--system"></a>`monitor::system`
+
+Class for managing the Obmondo system monitoring
+
+## Defined types
+
+### <a name="monitor--alert"></a>`monitor::alert`
+
+Prometheus monitoring alert
+
+#### Parameters
+
+The following parameters are available in the `monitor::alert` defined type:
+
+* [`alert_id`](#-monitor--alert--alert_id)
+* [`enable`](#-monitor--alert--enable)
+* [`noop_value`](#-monitor--alert--noop_value)
+* [`disable`](#-monitor--alert--disable)
+
+##### <a name="-monitor--alert--alert_id"></a>`alert_id`
+
+Data type: `String`
+
+The identifier for the alert. Defaults to $title.
+
+Default value: `$title`
+
+##### <a name="-monitor--alert--enable"></a>`enable`
+
+Data type: `Boolean`
+
+Whether the alert is enabled. Defaults to true.
+
+Default value: `true`
+
+##### <a name="-monitor--alert--noop_value"></a>`noop_value`
+
+Data type: `Boolean`
+
+The noop value used in monitoring. Defaults to $monitor::noop_value.
+
+Default value: `$monitor::noop_value`
+
+##### <a name="-monitor--alert--disable"></a>`disable`
+
+Data type: `Monitor::Disable`
+
+Optional disable configuration.
+
+Default value: `undef`
+
+### <a name="monitor--domains"></a>`monitor::domains`
+
+Class for managing monitoring of domains and certificate expiry
+
+#### Parameters
+
+The following parameters are available in the `monitor::domains` defined type:
+
+* [`enable`](#-monitor--domains--enable)
+* [`expiry_days`](#-monitor--domains--expiry_days)
+* [`domain`](#-monitor--domains--domain)
+
+##### <a name="-monitor--domains--enable"></a>`enable`
+
+Data type: `Boolean`
+
+Boolean flag to enable or disable the monitoring. Defaults to true.
+
+Default value: `true`
+
+##### <a name="-monitor--domains--expiry_days"></a>`expiry_days`
+
+Data type: `Integer[1,25]`
+
+Number of days before expiry to alert. Defaults to 25.
+
+Default value: `25`
+
+##### <a name="-monitor--domains--domain"></a>`domain`
+
+Data type: `Eit_types::Monitor::Domains`
+
+The domain to monitor. Defaults to $title.
+
+Default value: `$title`
+
+### <a name="monitor--threshold"></a>`monitor::threshold`
+
+Class for defining Prometheus monitoring thresholds
+
+#### Parameters
+
+The following parameters are available in the `monitor::threshold` defined type:
+
+* [`record`](#-monitor--threshold--record)
+* [`enable`](#-monitor--threshold--enable)
+* [`noop_value`](#-monitor--threshold--noop_value)
+* [`expr`](#-monitor--threshold--expr)
+* [`labels`](#-monitor--threshold--labels)
+* [`override`](#-monitor--threshold--override)
+
+##### <a name="-monitor--threshold--record"></a>`record`
+
+Data type: `String`
+
+The name of the threshold record. Must start with 'monitor::'.
+
+Default value: `$title`
+
+##### <a name="-monitor--threshold--enable"></a>`enable`
+
+Data type: `Boolean`
+
+Whether the threshold is enabled. Defaults to true.
+
+Default value: `true`
+
+##### <a name="-monitor--threshold--noop_value"></a>`noop_value`
+
+Data type: `Boolean`
+
+The noop value for the monitor. Defaults to $monitor::noop_value.
+
+Default value: `$monitor::noop_value`
+
+##### <a name="-monitor--threshold--expr"></a>`expr`
+
+Data type: `Any`
+
+The expression threshold. Defaults to 1.
+
+Default value: `1`
+
+##### <a name="-monitor--threshold--labels"></a>`labels`
+
+Data type: `Hash`
+
+A hash of labels for the threshold. Defaults to {}.
+
+Default value: `{}`
+
+##### <a name="-monitor--threshold--override"></a>`override`
+
+Data type: `Monitor::Override`
+
+Optional override for threshold parameters. Defaults to undef.
+
+Default value: `undef`
+