Call the product OpenBolt in the generated reference docs

bolt-modules/boltlib/lib/puppet/datatypes/result.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# For each target that you execute an action on, Bolt returns a `Result` object
+# For each target that you execute an action on, OpenBolt returns a `Result` object
 # and adds the `Result` to a `ResultSet` object. A `Result` object contains
 # information about the action you executed on the target.
 #

bolt-modules/boltlib/lib/puppet/datatypes/resultset.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-# For each target that you execute an action on, Bolt returns a `Result` object
+# For each target that you execute an action on, OpenBolt returns a `Result` object
 # and adds the `Result` to a `ResultSet` object. In the case of [apply
-# actions](applying_manifest_blocks.md), Bolt returns a `ResultSet` with one or
+# actions](applying_manifest_blocks.md), OpenBolt returns a `ResultSet` with one or
 # more `ApplyResult` objects.
 #
 # @param results

bolt-modules/boltlib/lib/puppet/datatypes/target.rb

@@ -6,7 +6,7 @@
 #   The inventory configuration for the target. This function returns the
 #   configuration set directly on the target in `inventory.yaml` or set in
 #   a plan using `Target.new` or `set_config()`. It does not return default
-#   configuration values or configuration set in Bolt configuration files.
+#   configuration values or configuration set in OpenBolt configuration files.
 # @param facts
 #   The target's facts. This function does not look up facts for a target and
 #   only returns the facts specified in an `inventory.yaml` file or set on a
@@ -49,7 +49,7 @@
 #   The transport used to connect to the target.
 # @!method transport_config
 #   The merged configuration for the target's `transport`. This function returns
-#   configuration that includes defaults set by Bolt, configuration set in
+#   configuration that includes defaults set by OpenBolt, configuration set in
 #   `inventory.yaml`, configuration set in `bolt-defaults.yaml`, and configuration
 #   set in a plan using `set_config()`.
 # @!method user

bolt-modules/boltlib/lib/puppet/functions/apply_prep.rb

@@ -4,13 +4,13 @@
 require 'bolt/task'
 
 # Installs the `openvox-agent` package on targets if needed, then collects facts,
-# including any custom facts found in Bolt's module path. The package is
+# including any custom facts found in OpenBolt's module path. The package is
 # installed using either the configured plugin or the `task` plugin with the
 # `openvox_bootstrap::install` task.
 #
 # Agent installation will be skipped if the target includes the `puppet-agent`
 # feature, either as a property of its transport or by explicitly setting
-# it as a feature in Bolt's inventory.
+# it as a feature in OpenBolt's inventory.
 #
 # > **Note:** Not available in apply block
 Puppet::Functions.create_function(:apply_prep) do

bolt-modules/boltlib/lib/puppet/functions/background.rb

@@ -9,7 +9,7 @@
   # Returns a Future object.
   # @param name An optional name for legible logs.
   # @param block The code block to run in the background.
-  # @return A Bolt Future object
+  # @return A Future object
   # @example Start a long-running process
   #   background() || {
   #     run_task('superlong::task', $targets)

bolt-modules/boltlib/lib/puppet/functions/fail_plan.rb

@@ -5,7 +5,7 @@
 # Raises a `Bolt::PlanFailure` exception to signal to callers that the plan failed.
 #
 # Plan authors should call this function when their plan is not successful. The
-# error may then be caught by another plans `run_plan` function or in Bolt itself
+# error may then be caught by another plans `run_plan` function or in OpenBolt itself
 #
 # > **Note:** Not available in apply block
 Puppet::Functions.create_function(:fail_plan) do

bolt-modules/boltlib/lib/puppet/functions/get_resources.rb

@@ -2,7 +2,7 @@
 
 require 'bolt/task'
 
-# Query the state of resources on a list of targets using resource definitions in Bolt's module path.
+# Query the state of resources on a list of targets using resource definitions in OpenBolt's module path.
 # The results are returned as a list of hashes representing each resource.
 #
 # Requires the Puppet Agent be installed on the target, which can be accomplished with apply_prep

bolt-modules/boltlib/lib/puppet/functions/puppetdb_command.rb

@@ -6,7 +6,7 @@
 #
 # The `pdb_command` function only supports version 5 of the `replace_facts`
 # command. Other commands might also work, but are not tested or supported
-# by Bolt.
+# by OpenBolt.
 #
 # See the [commands endpoint](https://puppet.com/docs/puppetdb/latest/api/command/v1/commands.html)
 # documentation for more information about available commands and payload

bolt-modules/boltlib/lib/puppet/functions/puppetdb_query.rb

@@ -3,7 +3,7 @@
 require 'bolt/error'
 
 # Makes a query to [puppetdb](https://puppet.com/docs/puppetdb/latest/index.html)
-# using Bolt's PuppetDB client.
+# using OpenBolt's PuppetDB client.
 Puppet::Functions.create_function(:puppetdb_query) do
   # Make a query to PuppetDB.
   #

bolt-modules/boltlib/lib/puppet/functions/run_plan.rb

@@ -12,7 +12,7 @@
   # @option args [Boolean] _catch_errors Whether to catch raised errors.
   # @option args [String] _run_as User to run as using privilege escalation.
   #   This option sets the [run-as user](privilege_escalation.md) for all
-  #   targets whenever Bolt connects to a target. This is set for all functions
+  #   targets whenever OpenBolt connects to a target. This is set for all functions
   #   in the called plan, including `run_plan()`.
   # @return [PlanResult] The result of running the plan. Undef if plan does not explicitly return results.
   # @example Run a plan
@@ -35,7 +35,7 @@
   # @option args [Boolean] _catch_errors Whether to catch raised errors.
   # @option args [String] _run_as User to run as using privilege escalation.
   #   This option sets the [run-as user](privilege_escalation.md) for all
-  #   targets whenever Bolt connects to a target. This is set for all functions
+  #   targets whenever OpenBolt connects to a target. This is set for all functions
   #   in the called plan, including `run_plan()`.
   # @return [PlanResult] The result of running the plan. Undef if plan does not explicitly return results.
   # @example Run a plan

bolt-modules/boltlib/lib/puppet/functions/wait.rb

@@ -8,7 +8,7 @@
 # > **Note:** Not available in apply block
 Puppet::Functions.create_function(:wait, Puppet::Functions::InternalFunction) do
   # Wait for Futures to finish.
-  # @param futures A Bolt Future object or array of Bolt Futures to wait on.
+  # @param futures A Future object or array of Futures to wait on.
   # @param options A hash of additional options.
   # @option options [Boolean] _catch_errors Whether to catch raised errors.
   # @return A Result or Results from the Futures
@@ -57,7 +57,7 @@
   end
 
   # Wait for Futures to finish with timeout.
-  # @param futures A Bolt Future object or array of Bolt Futures to wait on.
+  # @param futures A Future object or array of Futures to wait on.
   # @param timeout How long to wait for Futures to finish before raising a Timeout error.
   # @param options A hash of additional options.
   # @option options [Boolean] _catch_errors Whether to catch raised errors.

bolt-modules/file/lib/puppet/functions/file/delete.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Delete a file on localhost using ruby's `File.delete`. This will only delete
-# files on the machine you run Bolt on.
+# files on the machine you run OpenBolt on.
 Puppet::Functions.create_function(:'file::delete') do
   # @param filename Absolute path.
   # @example Delete a file from disk

bolt-modules/file/lib/puppet/functions/file/exists.rb

@@ -2,7 +2,7 @@
 
 # Check if a local file exists using Puppet's
 # `Puppet::Parser::Files.find_file()` function. This will only check files that
-# are on the machine Bolt is run on.
+# are on the machine OpenBolt is run on.
 Puppet::Functions.create_function(:'file::exists', Puppet::Functions::InternalFunction) do
   # @param filename Absolute path or Puppet file path.
   # @return Whether the file exists.

bolt-modules/file/lib/puppet/functions/file/read.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Read a file on localhost and return its contents using ruby's `File.read`. This will
-# only read files on the machine you run Bolt on.
+# only read files on the machine you run OpenBolt on.
 Puppet::Functions.create_function(:'file::read', Puppet::Functions::InternalFunction) do
   # @param filename Absolute path or Puppet file path.
   # @return The file's contents.

bolt-modules/file/lib/puppet/functions/file/readable.rb

@@ -2,7 +2,7 @@
 
 # Check if a local file is readable using Puppet's
 # `Puppet::Parser::Files.find_file()` function. This will only check files on the
-# machine you run Bolt on.
+# machine you run OpenBolt on.
 Puppet::Functions.create_function(:'file::readable', Puppet::Functions::InternalFunction) do
   # @param filename Absolute path or Puppet file path.
   # @return Whether the file is readable.

bolt-modules/file/lib/puppet/functions/file/write.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Write a string to a file on localhost using ruby's `File.write`. This will
-# only write files to the machine you run Bolt on. Use `write_file()` to write
+# only write files to the machine you run OpenBolt on. Use `write_file()` to write
 # to remote targets.
 Puppet::Functions.create_function(:'file::write') do
   # @param filename Absolute path.

bolt-modules/log/lib/puppet/functions/log/debug.rb

@@ -8,7 +8,7 @@
 # what a plan is doing. For example, you might log a message at the `debug`
 # level that shows what value is returned from a function invocation.
 #
-# See [Logs](logs.md) for more information about Bolt's log levels.
+# See [Logs](logs.md) for more information about OpenBolt's log levels.
 #
 # > **Note:** Not available in apply block
 Puppet::Functions.create_function(:'log::debug') do

bolt-modules/log/lib/puppet/functions/log/error.rb

@@ -9,7 +9,7 @@
 # `error` level if you want to inform the user an action running on a target
 # failed but that the plan will continue running.
 #
-# See [Logs](logs.md) for more information about Bolt's log levels.
+# See [Logs](logs.md) for more information about OpenBolt's log levels.
 #
 # > **Note:** Not available in apply block
 Puppet::Functions.create_function(:'log::error') do

bolt-modules/log/lib/puppet/functions/log/fatal.rb

@@ -9,7 +9,7 @@
 # `fatal` level if a service is unavailable and the plan cannot continue running
 # without it.
 #
-# See [Logs](logs.md) for more information about Bolt's log levels.
+# See [Logs](logs.md) for more information about OpenBolt's log levels.
 #
 # > **Note:** Not available in apply block
 Puppet::Functions.create_function(:'log::fatal') do

bolt-modules/log/lib/puppet/functions/log/info.rb

@@ -8,7 +8,7 @@
 # what a plan is doing. For example, you might log a message at the `info` level
 # that informs users that the plan is reading a file on disk.
 #
-# See [Logs](logs.md) for more information about Bolt's log levels.
+# See [Logs](logs.md) for more information about OpenBolt's log levels.
 #
 # > **Note:** Not available in apply block
 Puppet::Functions.create_function(:'log::info') do

bolt-modules/log/lib/puppet/functions/log/trace.rb

@@ -8,7 +8,7 @@
 # about what a plan is doing. For example, you might log a message at the `trace`
 # level that describes how a plan is manipulating data.
 #
-# See [Logs](logs.md) for more information about Bolt's log levels.
+# See [Logs](logs.md) for more information about OpenBolt's log levels.
 #
 # > **Note:** Not available in apply block
 Puppet::Functions.create_function(:'log::trace') do

bolt-modules/log/lib/puppet/functions/log/warn.rb

@@ -10,7 +10,7 @@
 # planning to make a breaking change to your plan in a future release and
 # want to notify users.
 #
-# See [Logs](logs.md) for more information about Bolt's log levels.
+# See [Logs](logs.md) for more information about OpenBolt's log levels.
 #
 # > **Note:** Not available in apply block
 Puppet::Functions.create_function(:'log::warn') do

documentation/templates/bolt_cmdlet_reference.md.erb

@@ -10,7 +10,7 @@ documentation](bolt_installing.html#puppetbolt-powershell-module).
 
 ## Cmdlet syntax
 
-Bolt PowerShell cmdlets follow a verb-noun convention.
+OpenBolt PowerShell cmdlets follow a verb-noun convention.
 
 To view a full list of available cmdlets, use the `Get-Command` cmdlet:
 
@@ -20,7 +20,7 @@ Get-Command -Module PuppetBolt
 
 ## Cmdlets
 
-These PowerShell cmdlets are available in the Bolt PowerShell module.
+These PowerShell cmdlets are available in the PuppetBolt PowerShell module.
 
 <% @commands.each do |command| %>
 ### <%= command[:cmdlet] %>

documentation/templates/bolt_command_reference.md.erb

@@ -7,7 +7,7 @@ title: "*nix shell commands"
 
 ## Command syntax
 
-Bolt shell commands follow a noun-verb convention.
+OpenBolt shell commands follow a noun-verb convention.
 
 To view a full list of
 available commands, use the `bolt help` command:
@@ -18,7 +18,7 @@ bolt help
 
 ## Commands
 
-These subcommands, actions, and options are available for Bolt.
+These subcommands, actions, and options are available for OpenBolt.
 
 <% @commands.each do |key, val| %>
 ### <%= key %>

documentation/templates/bolt_project_reference.md.erb

@@ -6,7 +6,7 @@ title: bolt-project.yaml options
 # `bolt-project.yaml` options
 
 This page lists the configuration options that are available in the `bolt-project.yaml`.
-For more information, see [Configuring Bolt](configuring_bolt.html).
+For more information, see [Configuring OpenBolt](configuring_bolt.html).
 
 ## Options
 
@@ -67,4 +67,4 @@ _This option is deprecated._
 
 📖 **Related information**  
 
-- [Bolt projects](projects.html)
+- [OpenBolt projects](projects.html)

documentation/templates/bolt_transports_reference.md.erb

@@ -5,7 +5,7 @@ title: Transport configuration options
 
 # Transport configuration options
 
-This page lists the configuration options that are available to each transport used by Bolt to connect
+This page lists the configuration options that are available to each transport used by OpenBolt to connect
 to targets. These options can be set in multiple locations:
 
 - Under a `config` key in an [inventory file](inventory_files.html).
@@ -57,13 +57,13 @@ to targets. These options can be set in multiple locations:
 <% if option == 'ssh' -%>
 ## OpenSSH Config
 
-Bolt's SSH transport uses the Ruby library `net-ssh`, which is a pure Ruby
+OpenBolt's SSH transport uses the Ruby library `net-ssh`, which is a pure Ruby
 implementation of the SSH2 client protocol. The library reads and uses some,
 but not all, settings from the user's OpenSSH configuration file (typically
 `~/.ssh/config`). OpenSSH configuration takes the [lowest
 precedence](configuring_bolt.html#configuration-precedence), and any configurable
-settings that you've set through Bolt, such as `port`, override the OpenSSH
-settings. Bolt uses the following OpenSSH configuration options when using the
+settings that you've set through OpenBolt, such as `port`, override the OpenSSH
+settings. OpenBolt uses the following OpenSSH configuration options when using the
 SSH transport:
 
 ### `Ciphers`
@@ -112,10 +112,10 @@ Path to local user's host key database.
 
 ## Native `ssh`
 
-Bolt's SSH transport uses the Ruby library `net-ssh`, which is a pure Ruby
+OpenBolt's SSH transport uses the Ruby library `net-ssh`, which is a pure Ruby
 implementation of the SSH2 client protocol. While robust, the library lacks
 support for some features and algorithms that are available in native SSH.
-When you use the native SSH transport, Bolt uses the SSH executable you've
+When you use the native SSH transport, OpenBolt uses the SSH executable you've
 specified instead of using `net-ssh`.
 
 Set the `native-ssh` config option or pass `--native-ssh` on the command line

documentation/templates/bolt_types_reference.md.erb

@@ -5,11 +5,11 @@ title: Data types
 
 # Data types
 
-This page lists custom data types used in Bolt plans and their functions.
+This page lists custom data types used in plans and their functions.
 
 ## Custom data types
 
-Bolt ships with several custom data types that can be used within a plan.
+OpenBolt ships with several custom data types that can be used within a plan.
 
 <% @types.each do |data| -%>
 ### `<%= data['name'] %>`
@@ -36,7 +36,7 @@ includes the following keys on the `value` hash:
 | Key | Type | Description |
 | --- | --- | --- |
 | `exit_code` | `Number` | The command's or script's exit code. |
-| `merged_output` | `String` | Output written to both standard error (stderr) and standard out (stdout) in the order that Bolt received the output. |
+| `merged_output` | `String` | Output written to both standard error (stderr) and standard out (stdout) in the order that OpenBolt received the output. |
 | `stderr` | `String` | Output written to standard error (stderr). |
 | `stdout` | `String` | Output written to standard out (stdout). |
 
@@ -53,7 +53,7 @@ following key on the `value` hash:
 
 ## Type Aliases
 
-Bolt also ships with type aliases, which provide an alternate name for existing types or lists of
+OpenBolt also ships with type aliases, which provide an alternate name for existing types or lists of
 types. These types can be used within a plan, and have all of the attributes and functions of
 whichever Puppet type they are set to in the plan.
 
@@ -66,7 +66,7 @@ A `TargetSpec` is an alias for any of the following types:
 
 You can pass `TargetSpec` objects to `get_targets()` to return an `Array[Target]`. Generally, you shouldn't
 need to worry about the distinction between `TargetSpec` and `Target`/`Array[Target]`, because most
-Bolt plan functions handle them automatically. But if your use case requires it,
+plan functions handle them automatically. But if your use case requires it,
 you can use `get_targets()` to return an exact list of targets.
 
 📖  **Related information**

documentation/templates/packaged_modules.md.erb

@@ -5,11 +5,11 @@ title: Packaged modules
 
 # Packaged modules
 
-The following modules are shipped with Bolt packages.
+The following modules are shipped with OpenBolt packages.
 
 ## Forge modules
 
-The following Forge modules are shipped with Bolt packages.
+The following Forge modules are shipped with OpenBolt packages.
 
 | Module | Version | Description |
 | --- | --- | --- |
@@ -19,7 +19,7 @@ The following Forge modules are shipped with Bolt packages.
 
 ## Local modules
 
-The following modules are shipped with Bolt packages and are not available
+The following modules are shipped with OpenBolt packages and are not available
 on the Puppet Forge.
 
 | Module | Description |

documentation/templates/plan_functions.md.erb

@@ -5,9 +5,9 @@ title: Plan functions
 
 # Plan functions
 
-Plans can use functions that are built into Bolt and Puppet, or custom
+Plans can use functions that are built into OpenBolt and Puppet, or custom
 functions included in modules. This reference
-page includes a list of built-in Bolt functions. To see a list of built-in
+page includes a list of built-in OpenBolt functions. To see a list of built-in
 Puppet functions, see Puppet's [built-in function
 reference](https://puppet.com/docs/puppet/latest/function.html). To learn how
 to write custom Puppet functions, see [the Puppet documentation on writing