Merge pull request #9447 from joshcooper/doc_updates2

Update docs

Author: joshcooper

Diff for: lib/puppet/application/filebucket.rb

@@ -76,10 +76,11 @@ def help
       use your local file bucket by specifying '--local', or by specifying
       '--bucket' with a local path.
 
-      > **Note**: Enabling and using the backup option, and by extension the
-        filebucket resource, requires appropriate planning and management to ensure
-        that sufficient disk space is available for the file backups. Generally, you
-        can implement this using one of the following two options:
+      **Note**: Enabling and using the backup option, and by extension the
+      filebucket resource, requires appropriate planning and management to ensure
+      that sufficient disk space is available for the file backups. Generally, you
+      can implement this using one of the following two options:
+
         - Use a `find` command and `crontab` entry to retain only the last X days
         of file backups. For example:
 
@@ -187,6 +188,7 @@ def help
 
           $ puppet filebucket -l -t "2015-05-11 09:30:00" list
           d43a6ecaa892a1962398ac9170ea9bf2 2015-05-11 09:27:56 /tmp/TestFile
+
           ## Manage files in a specific local filebucket
           $ puppet filebucket -b /tmp/TestBucket backup /tmp/TestFile2
           /tmp/TestFile2: d41d8cd98f00b204e9800998ecf8427e

Diff for: lib/puppet/defaults.rb

@@ -2126,10 +2126,12 @@ def self.initialize_default_settings!(settings)
           can produce node information. The command must:
 
           * Take the name of a node as a command-line argument.
+
           * Return a YAML hash with up to three keys:
             * `classes` --- A list of classes, as an array or hash.
             * `environment` --- A string.
             * `parameters` --- A list of top-scope variables to set, as a hash.
+
           * For unknown nodes, exit with a non-zero exit code.
 
           Generally, an ENC script makes requests to an external data source.

Diff for: lib/puppet/face/catalog.rb

@@ -26,7 +26,7 @@
   deactivate_action(:destroy)
   deactivate_action(:search)
   action(:find) do
-    summary _("Retrieve the catalog for the node from which the comamand is run.")
+    summary _("Retrieve the catalog for the node from which the command is run.")
     arguments "<certname>, <facts>"
     option("--facts_for_catalog") do
       summary _("Not yet implemented for the CLI; facts will be collected internally.")

Diff for: lib/puppet/reference/configuration.rb

@@ -95,6 +95,5 @@
 
   [confguide]: https://puppet.com/docs/puppet/latest/config_about_settings.html
 
-  * * *
 
 EOT

Diff for: lib/puppet/util/reference.rb

@@ -84,7 +84,6 @@ def text
   def to_markdown(withcontents = true)
     # First the header
     text = markdown_header(@title, 1)
-    text << _("\n\n**This page is autogenerated; any changes will get overwritten**\n\n")
 
     text << @header
 

Diff for: man/man5/puppet.conf.5

@@ -2,7 +2,6 @@
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
 .TH "PUPPETCONF" "5" "August 2024" "Puppet, Inc." "Puppet manual"
-\fBThis page is autogenerated; any changes will get overwritten\fR
 .
 .SH "Configuration settings"
 .
@@ -690,6 +689,7 @@ This setting\'s value must be the path to an executable command that can produce
 Take the name of a node as a command\-line argument\.
 .
 .IP "\(bu" 4
+Return a YAML hash with up to three keys:
 .
 .IP "\(bu" 4
 \fBclasses\fR \-\-\- A list of classes, as an array or hash\.

Diff for: man/man8/puppet-catalog.8

@@ -109,7 +109,7 @@ Nothing\.
 When used from the Ruby API, this action has a side effect of leaving Puppet::Resource::Catalog\.indirection\.terminus_class set to yaml\. The terminus must be explicitly re\-set for subsequent catalog actions\.
 .
 .TP
-\fBfind\fR \- Retrieve the catalog for the node from which the comamand is run\.
+\fBfind\fR \- Retrieve the catalog for the node from which the command is run\.
 \fBSYNOPSIS\fR
 .
 .IP
@@ -119,7 +119,7 @@ puppet catalog find [\-\-terminus _TERMINUS] [\-\-facts_for_catalog] \fIcertname
 \fBDESCRIPTION\fR
 .
 .IP
-Retrieve the catalog for the node from which the comamand is run\.
+Retrieve the catalog for the node from which the command is run\.
 .
 .IP
 \fBOPTIONS\fR \fI\-\-facts_for_catalog\fR \- Not yet implemented for the CLI; facts will be collected internally\.

Diff for: man/man8/puppet-filebucket.8

@@ -36,6 +36,14 @@ This is a stand\-alone filebucket client for sending files to a local or central
 .P
 Note that \'filebucket\' defaults to using a network\-based filebucket available on the server named \'puppet\'\. To use this, you\'ll have to be running as a user with valid Puppet certificates\. Alternatively, you can use your local file bucket by specifying \'\-\-local\', or by specifying \'\-\-bucket\' with a local path\.
 .
+.P
+\fBNote\fR: Enabling and using the backup option, and by extension the filebucket resource, requires appropriate planning and management to ensure that sufficient disk space is available for the file backups\. Generally, you can implement this using one of the following two options:
+.
+.IP "\(bu" 4
+Use a \fBfind\fR command and \fBcrontab\fR entry to retain only the last X days of file backups\. For example:
+.
+.IP "" 0
+.
 .IP "" 4
 .
 .nf
@@ -146,6 +154,7 @@ $ puppet filebucket \-l \-f "2015\-05\-11 09:30:00" list
 
 $ puppet filebucket \-l \-t "2015\-05\-11 09:30:00" list
 d43a6ecaa892a1962398ac9170ea9bf2 2015\-05\-11 09:27:56 /tmp/TestFile
+
 ## Manage files in a specific local filebucket
 $ puppet filebucket \-b /tmp/TestBucket backup /tmp/TestFile2
 /tmp/TestFile2: d41d8cd98f00b204e9800998ecf8427e