Skip to content

Commit 5fe2a67

Browse files
committed
docs: repoint puppet.com/docs links to OpenVox equivalents (openbolt)
Completes the openbolt portion of the puppet.com link cleanup. These are all in committed narrative pages; the 9 generated reference pages are managed upstream and not touched here. - puppet/* -> /openvox/latest/* (cross-collection), with renames (puppet_strings -> openvox_strings, release_notes_puppet -> release_notes, writing_custom_functions -> functions_basics). Several anchors corrected to the OpenVox page versions, since OpenVox pages use different ids (e.g. #module-structure, #puppet-lookup, #classes-and-defined-resource-types, lang_data_abstract#data); anchors with no OpenVox equivalent section drop to the page (format_report, release_notes, subsystem_catalog_compilation). - bolt/* -> within-collection relative links (inventory_file -> inventory_files). - puppetdb/* -> /openvoxdb/latest/*; facter -> /openfact/latest/. - pdk/* -> /pdk.html, the OpenVox-hosted PDK page (Puppet has moved newer PDK behind a paywall, so the puppet.com links were partly dead anyway). - Remove dead Puppet Enterprise references: unlink the PE control-repo tip in projects.md, and drop the "Puppet Enterprise" entry from the related- products list in bolt.md. - Keep the lone puppet_index link in developer_updates.md (a historical reference to upstream Puppet 7). Verified: jekyll build passes; every repointed target and anchor resolves (checked link anchors against target page ids, not just page existence); git diff --check clean. Part of #295 Signed-off-by: Michael Harp <mike@mikeharp.com>
1 parent 458f313 commit 5fe2a67

22 files changed

Lines changed: 73 additions & 74 deletions

docs/_openbolt_5x/applying_manifest_blocks.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,13 @@ limitations](#manifest-block-limitations).
3030
## Applying manifest blocks from the command line
3131

3232
Similar to the [`puppet apply`
33-
command](https://puppet.com/docs/puppet/latest/man/apply.html), which applies a
33+
command](/openvox/latest/man/apply.html), which applies a
3434
standalone Puppet manifest to a local system, you can use Bolt to apply
3535
Puppet manifests to remote targets.
3636

3737
Manifest blocks require facts to compile. When Bolt applies Puppet manifests, it
3838
automatically installs the packages necessary to run the apply command and
39-
gathers facts using [facter](https://puppet.com/docs/facter/latest/), making the
39+
gathers facts using [facter](/openfact/latest/), making the
4040
facts available to the manifest block. Bolt also identifies targets that do not
4141
have Puppet agents and runs the [`openvox_bootstrap::install`
4242
task](https://forge.puppet.com/puppet/openvox_bootstrap) to install the agent.
@@ -104,9 +104,9 @@ Manifest only contains definitions and will result in no changes on the targets.
104104
📖 **Related information**
105105

106106
- [Defining and declaring
107-
classes](https://puppet.com/docs/puppet/latest/lang_classes.html)
107+
classes](/openvox/latest/lang_classes.html)
108108
- [Defining and declaring defined
109-
types](https://puppet.com/docs/puppet/latest/lang_defined_types.html)
109+
types](/openvox/latest/lang_defined_types.html)
110110

111111
### How manifest blocks are applied
112112

@@ -163,7 +163,7 @@ Manifest blocks require facts to compile. If your plan includes a manifest
163163
block, use the `apply_prep` function in your plan _before_ your manifest block.
164164
The `apply_prep` function installs the packages necessary to run the apply
165165
command and gathers facts by running
166-
[facter](https://puppet.com/docs/facter/latest/), making the facts available to
166+
[facter](/openfact/latest/), making the facts available to
167167
the manifest block. The `apply_prep` function also identifies the targets that
168168
do not have Puppet agents and runs the [`puppet_agent::install`
169169
task](https://forge.puppet.com/puppetlabs/puppet_agent) to install the agent.
@@ -216,9 +216,9 @@ returns the reports generated by applying the catalog on each target.
216216
### Return value
217217

218218
The `apply` function returns a [`ResultSet`
219-
object](https://puppet.com/docs/bolt/latest/bolt_types_reference.html#resultset)
219+
object](bolt_types_reference.html#resultset)
220220
that contains an [`ApplyResult`
221-
object](https://puppet.com/docs/bolt/latest/bolt_types_reference.html#applyresult)
221+
object](bolt_types_reference.html#applyresult)
222222
for each target.
223223

224224
```puppet
@@ -232,7 +232,7 @@ $results.each |$result| {
232232

233233
The [`ApplyResult` object](bolt_types_reference.html#applyresult) includes a
234234
`report` method that returns a hash representation of the
235-
[`Puppet::Transaction::Report`](https://puppet.com/docs/puppet/latest/format_report.html)
235+
[`Puppet::Transaction::Report`](/openvox/latest/format_report.html)
236236
object. Each property on the object corresponds to a key with the same name in
237237
the report hash. However, not every property is presented in the hash for every
238238
result. Only properties that have a value from the apply are present in the
@@ -290,7 +290,7 @@ hand, uses the Bolt default thread pool controlled by the `concurrency` option.
290290

291291
## Using Hiera data in a manifest block
292292

293-
Use [Hiera](https://puppet.com/docs/puppet/latest/hiera_intro.html) to separate
293+
Use [Hiera](/openvox/latest/hiera_intro.html) to separate
294294
configuration from context-specific data, where context might be fact-based or the
295295
name of a target.
296296

@@ -299,7 +299,7 @@ name of a target.
299299
Hiera is a key-value configuration data look up system, used for separating data
300300
from Puppet code. You use Hiera data to implicitly override default class
301301
parameters. You can also explicitly look up data from Hiera via the [`lookup`
302-
function](https://puppet.com/docs/puppet/latest/function.html#lookup):
302+
function](/openvox/latest/function.html#lookup):
303303

304304
```puppet
305305
plan do_thing() {
@@ -316,19 +316,19 @@ You can change this with the `hiera-config` key in a Bolt config file or the
316316

317317
Following the Hiera 5 convention, the default data directory is relative to
318318
`hiera.yaml` at `<PROJECT DIRECTORY>/data`. For configuration file examples, see [Configuring
319-
Hiera](https://puppet.com/docs/puppet/latest/hiera_config_yaml_5.html). Bolt
319+
Hiera](/openvox/latest/hiera_config_yaml_5.html). Bolt
320320
will not automatically load any Hiera data from this directory. If you want to load data from a
321321
data file you must set the relevant paths in your Hiera config.
322322

323323
> **Note**: The target name is made available to Hiera as `trusted.certname`. You can learn more about
324324
[interpolating variables into Hiera config
325-
here](https://puppet.com/docs/puppet/latest/hiera_merging.html#interpolate_puppet_variable).
325+
here](/openvox/latest/hiera_merging.html#interpolate-a-puppet-variable).
326326

327327
If a custom data provider is used, such as `hiera-eyaml`, which allows you to
328328
encrypt your data, the gem dependencies must be available to Bolt. See [Install
329329
gems with Bolt packages](bolt_installing.html#).
330330

331-
[Hiera interpolations](https://puppet.com/docs/puppet/latest/hiera_merging.html#hiera_interpolation)
331+
[Hiera interpolations](/openvox/latest/hiera_merging.html#interpolation)
332332
are not supported in Bolt outside of apply blocks, because Hiera data is looked up per-target and
333333
plans do not run in a per-target context. If you want to use Hiera to look up data outside of an apply
334334
block, you can use a [plan hierarchy](#using-hiera-data-in-a-manifest-block).

docs/_openbolt_5x/automating_windows_targets.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,10 +110,10 @@ task runner executes the task.
110110
creating the `.ps1` file in a directory called `tasks`. Alternatively, you can
111111
use Puppet Development Kit (PDK), to create a task by using the [`pdk new
112112
task`
113-
command](https://puppet.com/docs/pdk/1.x/pdk_reference.html#pdk-new-task-command).
113+
command](/pdk.html).
114114
If you’re going to be creating a lot of tasks, using PDK is worth getting to
115115
know. For more information, see the [PDK
116-
documentation.](https://puppet.com/docs/pdk/1.x/pdk_overview.html)
116+
documentation.](/pdk.html)
117117
118118
1. In the `bolt-guide` directory, create the following subdirectories:
119119
```

docs/_openbolt_5x/bolt.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,8 @@ you are not required to install any agent software.
6868
</p>
6969
<p>Docs for related Puppet products
7070
<ul>
71-
<li><a class="xref" target="_blank" href="https://puppet.com/docs/puppet/latest/index.html">Open source Puppet</a></li>
72-
<li><a class="xref" target="_blank" href="https://puppet.com/docs/pe/latest/pe_user_guide.html">Puppet Enterprise®</a></li>
73-
<li><a class="xref" target="_blank" href="https://puppet.com/docs/pdk/latest/pdk.html">Puppet Development Kit</a></li>
71+
<li><a class="xref" target="_blank" href="/openvox/latest/index.html">Open source Puppet</a></li>
72+
<li><a class="xref" target="_blank" href="/pdk.html">Puppet Development Kit</a></li>
7473
</ul>
7574
</p>
7675
<p>Why and how people are using Bolt

docs/_openbolt_5x/bolt_installing_modules.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -279,7 +279,7 @@ requirement.
279279

280280
> 🔩 **Tip**: For information on how to specify module versions, see the Puppet
281281
> documentation on [Specifying
282-
> versions](https://puppet.com/docs/puppet/latest/modules_metadata.html#specifying-versions).
282+
> versions](/openvox/latest/modules_metadata.html#version-specifiers-in-module-metadata).
283283

284284
## Install Forge modules from an alternate Forge
285285

docs/_openbolt_5x/bolt_inventory_reference.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ config:
4040
### `facts`
4141

4242
A map of system information, also known as
43-
[facts](https://puppet.com/docs/puppet/latest/lang_facts_and_builtin_vars.html),
43+
[facts](/openvox/latest/lang_facts_and_builtin_vars.html),
4444
for the implicit `all` group. Facts set at this level apply to all groups and
4545
targets in the inventory file.
4646

@@ -138,7 +138,7 @@ groups:
138138
### `facts`
139139

140140
A map of system information, also known as
141-
[facts](https://puppet.com/docs/puppet/latest/lang_facts_and_builtin_vars.html),
141+
[facts](/openvox/latest/lang_facts_and_builtin_vars.html),
142142
for the group. Facts set at this level apply to all groups and targets under
143143
the group.
144144

@@ -301,7 +301,7 @@ targets:
301301
### `facts`
302302

303303
A map of system information, also known as
304-
[facts](https://puppet.com/docs/puppet/latest/lang_facts_and_builtin_vars.html),
304+
[facts](/openvox/latest/lang_facts_and_builtin_vars.html),
305305
for the target.
306306

307307
- **Type:** Hash

docs/_openbolt_5x/bolt_running_scripts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ target's operating system. This includes any scripting language the target can r
1212

1313
There are a few ways to reference scripts for Bolt to load:
1414
- _Preferred_: Using a [Puppet file
15-
reference](https://puppet.com/docs/puppet/latest/types/file.html#file-attribute-source) of the
15+
reference](/openvox/latest/types/file.html#file-attribute-source) of the
1616
form `<module>/scripts/myscript.sh`. Puppet file references load files from specific directories in
1717
modules that are on [the modulepath](modules.html#modulepath). You can load a script from the
1818
`files/` directory using `<module>/files/myscript.sh`, but the preferred place for scripts to be

docs/_openbolt_5x/developer_updates.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ we're making.
1616

1717
Currently, you can point to the location of a script or file as an absolute path
1818
or use a [Module-style load
19-
path](https://puppet.com/docs/puppet/latest/file_serving.html). Puppet
19+
path](/openvox/latest/file_serving.html). Puppet
2020
module-style paths use the syntax `<module_name>/<path_to_file>`, where the `<module_name>` is the
2121
name of the module on the modulepath to load from, and `<path_to_file>` is the path to the file
2222
within the `<module_name>/files/` subdirectory. For example, if you provided Bolt with
@@ -166,7 +166,7 @@ compiled a list of expected changes and removals.
166166
plans.
167167

168168
To read more about the changes in Puppet 7, see the [Puppet 7 release
169-
notes](https://puppet.com/docs/puppet/7.0/release_notes_puppet.html#release_notes_puppet_x-0-0).
169+
notes](/openvox/latest/release_notes.html).
170170

171171
- **Ship with Ruby 2.7**
172172

docs/_openbolt_5x/experimental_features.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ project-level policy named `myproject::user`, run:
6464

6565
Bolt creates an empty class in the project's `manifests/` directory that you can
6666
populate with code. Policy names must follow [class naming
67-
conventions](https://puppet.com/docs/puppet/7/lang_reserved.html#classes-and-defined-resource-type-names).
67+
conventions](/openvox/latest/lang_reserved.html#classes-and-defined-resource-types).
6868

6969

7070
Example output:
@@ -105,7 +105,7 @@ Modulepath
105105
### Applying policies to targets
106106

107107
Applying policies is similar to [applying Puppet
108-
code](https://puppet.com/docs/bolt/latest/applying_manifest_blocks.html), with
108+
code](applying_manifest_blocks.html), with
109109
the addition that you can apply one or more policies at a time. The Bolt
110110
commands for applying policies accept a single policy name or a comma-separated
111111
list of policy names to apply to a list of one or more targets.
@@ -736,8 +736,8 @@ Each `ResourceInstance` has the following attributes:
736736
| Parameter | Type | Description |
737737
| --- | --- | --- |
738738
| `target` | The target that the resource is for. | `Target` |
739-
| `type` | The [type of the resource](https://puppet.com/docs/puppet/latest/type.html). This can be either the stringified name of the resource type or the actual type itself. For example, both `"file"` and `File` are acceptable. | `Variant[String[1], Type[Resource]]` |
740-
| `title` | The title, or [namevar](https://puppet.com/docs/puppet/latest/type.html#namevars-and-titles), of the resource. | `String[1]` |
739+
| `type` | The [type of the resource](/openvox/latest/type.html). This can be either the stringified name of the resource type or the actual type itself. For example, both `"file"` and `File` are acceptable. | `Variant[String[1], Type[Resource]]` |
740+
| `title` | The title, or [namevar](/openvox/latest/type.html#namevars-and-titles), of the resource. | `String[1]` |
741741
| `state` | The _observed state_ of the resource. This is the point-in-time state of the resource when it is queried. | `Hash[String[1], Data]` |
742742
| `desired_state` | The _desired state_ of the resource. This is the state that you want the resource to be in. | `Hash[String[1], Data]` |
743743
| `events` | Resource events that are generated from reports. | `Array[Hash[String[1], Data]]` |

docs/_openbolt_5x/getting_started_with_bolt.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ New-BoltProject -Name my_project
6767
6868
To use Bolt plans or tasks, your Bolt project must use a specific directory
6969
structure. The directory structure of a Bolt project is closely tied to [Puppet
70-
modules](https://puppet.com/docs/puppet/latest/modules_fundamentals.html).
70+
modules](/openvox/latest/modules_fundamentals.html).
7171
Because your plan will install Apache, you need an `apache` module directory.
7272
Your `apache` directory needs `files` and `plans` subdirectories.
7373

docs/_openbolt_5x/glossary.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ the `apply_prep` plan function. See [`apply_prep`](#apply_prep).
2121

2222
📖 **Related information**
2323

24-
- [Applying Puppet code](https://puppet.com/docs/bolt/latest/applying_manifest_blocks.html)
24+
- [Applying Puppet code](applying_manifest_blocks.html)
2525

2626
## apply_prep
2727

@@ -31,7 +31,7 @@ path. The `puppet-agent` package and facts are required for an `apply`.
3131

3232
📖 **Related information**
3333

34-
- [Applying Puppet code](https://puppet.com/docs/bolt/latest/applying_manifest_blocks.html)
34+
- [Applying Puppet code](applying_manifest_blocks.html)
3535
- [`apply_prep` example](plan_functions.html#apply_prep)
3636

3737
## catalog
@@ -49,7 +49,7 @@ specific target, and generated by a target.
4949

5050
📖 **Related information**
5151

52-
- [Catalog compilation](https://puppet.com/docs/puppet/latest/subsystem_catalog_compilation.html#subsystem_catalog_compilation)
52+
- [Catalog compilation](/openvox/latest/subsystem_catalog_compilation.html)
5353

5454
## controller
5555

@@ -101,7 +101,7 @@ separate data from your code.
101101

102102
📖 **Related information**
103103

104-
- [How to use Hiera](https://puppet.com/docs/puppet/7/hiera_intro.html)
104+
- [How to use Hiera](/openvox/latest/hiera_intro.html)
105105
- [Using bolt with Hiera](hiera.html)
106106

107107
## inventory
@@ -198,8 +198,8 @@ into Bolt and Puppet, or custom functions
198198
📖 **Related information**
199199

200200
- [Bolt built-in functions](plan_functions.html)
201-
- [Puppet built-in functions](https://puppet.com/docs/puppet/7/function.html)
202-
- [More information on custom functions](https://puppet.com/docs/puppet/7/writing_custom_functions.html)
201+
- [Puppet built-in functions](/openvox/latest/function.html)
202+
- [More information on custom functions](/openvox/latest/functions_basics.html)
203203

204204
## plugin
205205

0 commit comments

Comments
 (0)