Merge pull request #4 from voxpupuli/docs

init.pp: Add puppet-strings documentation

REFERENCE.md

@@ -24,50 +24,50 @@ The following parameters are available in the `bolt` class:
 
 * [`version`](#-bolt--version)
 * [`base_url`](#-bolt--base_url)
+* [`release_package`](#-bolt--release_package)
 * [`gpgkey`](#-bolt--gpgkey)
 * [`use_release_package`](#-bolt--use_release_package)
-* [`release_package`](#-bolt--release_package)
 
 ##### <a name="-bolt--version"></a>`version`
 
 Data type: `String[1]`
 
-
+desired version for bolt
 
 Default value: `'3.29.0'`
 
 ##### <a name="-bolt--base_url"></a>`base_url`
 
 Data type: `Stdlib::HTTPSUrl`
 
-
+HTTPS URL to the yumrepo base
 
 Default value: `'https://yum.puppet.com/'`
 
-##### <a name="-bolt--gpgkey"></a>`gpgkey`
+##### <a name="-bolt--release_package"></a>`release_package`
 
 Data type: `String[1]`
 
+filename for the release package rpm
 
+Default value: `"puppet-tools-release-el-${facts['os']['release']['major']}.noarch.rpm"`
+
+##### <a name="-bolt--gpgkey"></a>`gpgkey`
+
+Data type: `String[1]`
+
+name of the GPG key filename in the repo
 
 Default value: `'RPM-GPG-KEY-puppet-20250406'`
 
 ##### <a name="-bolt--use_release_package"></a>`use_release_package`
 
 Data type: `Boolean`
 
-
+enable/disable the puppet-tools-release package installation. When disabled, we will configure the repo as yumrepo resource
 
 Default value: `true`
 
-##### <a name="-bolt--release_package"></a>`release_package`
-
-Data type: `String[1]`
-
-
-
-Default value: `"puppet-tools-release-el-${facts['os']['release']['major']}.noarch.rpm"`
-
 ## Defined types
 
 ### <a name="bolt--project"></a>`bolt::project`

manifests/init.pp

@@ -1,10 +1,11 @@
 #
 # @summary installs bolt via yumrepo or release package
 #
-# @param version
-# @param base_url
-# @param gpgkey
-# @param use_release_package
+# @param version desired version for bolt
+# @param base_url HTTPS URL to the yumrepo base
+# @param release_package filename for the release package rpm
+# @param gpgkey name of the GPG key filename in the repo
+# @param use_release_package enable/disable the puppet-tools-release package installation. When disabled, we will configure the repo as yumrepo resource
 #
 # @author Tim Meusel <[email protected]>
 #