Skip to content

Commit 391491f

Browse files
committed
Re-brand navbar, landing, and version pages
- Remove old bolt.html (now reachable by nav menu template fix) - Recover/adapt relevant 'bolt.html' page content into index page - Rebrand Bolt to OpenBolt on navbar, landing, and version pages - Fix various broken cross-links This is not a complete overhaul for branding and correctness, but it fixes what I needed to update before removing 'bolt.html' Signed-off-by: Chris Tessmer <chris.tessmer@onyxpoint.com>
1 parent 589fd6e commit 391491f

4 files changed

Lines changed: 81 additions & 108 deletions

File tree

_data/nav/openbolt_5x.yml

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,42 @@
11
---
2-
- text: Welcome to Puppet Bolt®
3-
link: bolt.html
2+
- text: Welcome to OpenBolt
3+
link: index.html
44
items:
55
- text: Developer updates
66
link: developer_updates.html
77
- text: Release notes
88
link: release_notes.html
9-
- text: Bolt versioning
9+
- text: OpenBolt versioning
1010
link: bolt_versioning.html
1111
- text: Known issues
1212
link: bolt_known_issues.html
13-
- text: Installing Bolt
13+
- text: Installing OpenBolt
1414
items:
15-
- text: Installing Bolt
15+
- text: Installing OpenBolt
1616
link: bolt_installing.html
17-
- text: Run Bolt from a Docker image
17+
- text: Run from a Docker image
1818
link: running_bolt_in_docker.html
19-
- text: Getting started with Bolt
19+
- text: Getting started with OpenBolt
2020
link: getting_started_with_bolt.html
21-
- text: Configuring Bolt
21+
- text: Configuring OpenBolt
2222
items:
2323
- text: Bolt projects
2424
link: projects.html
2525
- text: Inventory files
2626
link: inventory_files.html
27-
- text: Configuring Bolt
27+
- text: Configuring OpenBolt
2828
link: configuring_bolt.html
2929
- text: Logs
3030
link: logs.html
31-
- text: Escalating privilege with Bolt
31+
- text: Escalating privilege
3232
link: privilege_escalation.html
33-
- text: Setting up VS Code for Bolt
33+
- text: VS Code and OpenBolt
3434
link: vscode_and_bolt.html
35-
- text: Running Bolt
35+
- text: Running OpenBolt
3636
items:
37-
- text: Run Bolt
37+
- text: Run OpenBolt
3838
link: running_bolt_commands.html
39-
- text: Run Bolt on network devices
39+
- text: Run OpenBolt on network devices
4040
link: running_bolt_network.html
4141
- text: Scripts
4242
items:
@@ -88,20 +88,20 @@
8888
link: supported_plugins.html
8989
- text: Writing plugins
9090
link: writing_plugins.html
91-
- text: Using Bolt with Puppet
91+
- text: Using OpenBolt with Puppet/OpenVox
9292
items:
9393
- text: Applying Puppet code
9494
link: applying_manifest_blocks.html
95-
- text: Using Bolt with Hiera
95+
- text: Using OpenBolt with Hiera
9696
link: hiera.html
97-
- text: Connecting Bolt to PuppetDB
97+
- text: Connecting OpenBolt to PuppetDB
9898
link: bolt_connect_puppetdb.html
99-
- text: Bolt Examples
99+
- text: OpenBolt Examples
100100
link: bolt_examples.html
101101
items:
102102
- text: Automating Windows targets
103103
link: automating_windows_targets.html
104-
- text: Deploy a TIG stack with Bolt
104+
- text: Deploy a TIG stack with OpenBolt
105105
link: tig_stack.html
106106
- text: "\U0001F9EA Experimental features"
107107
link: experimental_features.html

docs/_openbolt_5x/bolt.md

Lines changed: 0 additions & 72 deletions
This file was deleted.
Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11
---
22
layout: default
3-
title: Bolt versioning
3+
title: OpenBolt versioning
44
---
55

6-
# Bolt versioning
6+
# OpenBolt versioning
77

8-
Bolt follows [semantic versioning](https://semver.org/) guidelines.
8+
OpenBolt follows [semantic versioning](https://semver.org/) guidelines.
99

1010
This system uses an "x.y.z" pattern, where "x" is the number of a major release,
1111
"y" indicates a minor release that introduces new features but does not include
1212
breaking changes, and "z" reflects a bug fix release.
1313

1414

15-
## Bolt API
15+
## OpenBolt API
1616

17-
The 2.0 series of Bolt is stable and will be free of breaking changes to its
17+
The 5.0 series of OpenBolt is stable and will be free of breaking changes to its
1818
public API. In general this means that plans, inventory and config tested with
19-
any 2.y series release of Bolt will continue to work when used with a later 2.y
20-
series release. You can expect the following types of changes in the 2.0 series:
19+
any 5.y series release of OpenBolt will continue to work when used with a later 5.y
20+
series release. You can expect the following types of changes in the 5.0 series:
2121

2222
- New keys in JSON format output.
2323
- Differences in log output and human format output.
@@ -27,8 +27,8 @@ series release. You can expect the following types of changes in the 2.0 series:
2727
- Versions of bundled modules will be updated and might include breaking
2828
changes.
2929

30-
## Bolt releases
30+
## OpenBolt releases
3131

32-
For the 2.y series of Bolt we do not plan to backport bug fixes to any
32+
For the 5.y series of OpenBolt we do not plan to backport bug fixes to any
3333
previously released version. You are encouraged to upgrade frequently and use
3434
the latest release.

docs/_openbolt_5x/index.md

Lines changed: 53 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
layout: default
3-
title: OpenBolt 5
3+
title: Welcome to OpenBolt 5
44
---
55

6-
OpenBolt is a community implementation of [Puppet Bolt](https://github.com/puppetlabs/bolt) — an open
7-
source orchestration tool that automates infrastructure management over SSH and WinRM without requiring
8-
agents. Use OpenBolt to run commands, scripts, and tasks across remote targets, or to orchestrate
9-
complex workflows using plans.
6+
OpenBolt is an open source community implementation of [Puppet Bolt](https://github.com/puppetlabs/bolt)
7+
— an orchestration tool that automates infrastructure management over SSH and WinRM without requiring
8+
product-specific agents. Use OpenBolt to run commands, scripts, and tasks across
9+
remote targets, or to orchestrate complex workflows using plans.
1010

1111
OpenBolt is downstream-compatible with Puppet Bolt — existing tasks, plans, modules, and inventory files work unchanged.
1212

@@ -20,12 +20,57 @@ Work is expressed at several levels:
2020

2121
- **Commands** — run a shell command directly on targets
2222
- **Scripts** — upload and execute a script file on targets
23-
- **Tasks** — self-contained, reusable units of automation with defined parameters; written in any language
24-
- **Plans** — Puppet or YAML programs that sequence tasks, commands, and scripts across multiple targets with conditional logic
23+
- **[Tasks](tasks.html)** — self-contained, reusable units of automation with defined parameters; written in any language
24+
- **[Plans](plans.html)** — Puppet or YAML programs that sequence tasks, commands, and scripts across multiple targets with conditional logic
2525

26-
## Getting started
26+
## Helpful OpenBolt docs links
2727

28+
### Install OpenBolt
29+
30+
- [Installing OpenBolt](bolt_installing.html) - Follow the installation instructions for your operating system: \*nix, macOS, or Windows.
31+
### Make one-time changes to your remote targets
32+
33+
- [Run a command](running_bolt_commands.html#run-a-command)
34+
- [Run a script](running_bolt_commands.html#run-a-script)
35+
- [Upload files](running_bolt_commands.html#upload-a-file-or-directory)
36+
37+
### Automate your workflow with existing tasks and plans
38+
39+
- [Running tasks](bolt_running_tasks.html)
40+
- [Running plans](bolt_running_plans.html)
41+
42+
### Create your own tasks and plans
2843
- [Installing OpenBolt](bolt_installing.html)
2944
- [Getting started with Bolt](getting_started_with_bolt.html)
3045
- [Writing tasks](writing_tasks.html)
3146
- [Writing plans](writing_plans.html)
47+
- [Writing plans in YAML](writing_yaml_plans.html)
48+
- [Example plans](writing_plans.html)
49+
- [Applying manifest blocks](applying_manifest_blocks.html)
50+
51+
## Other useful places
52+
53+
### Learn the basics
54+
55+
- [Getting started with OpenBolt](getting_started_with_bolt.html)
56+
- [OpenBolt examples](bolt_examples.html) - Guided examples of how OpenBolt can help you automate common tasks.
57+
58+
### Watch OpenBolt development
59+
60+
- [OpenBolt project on GitHub](https://github.com/OpenVoxProject/openbolt)
61+
62+
### Docs for related OpenVox products
63+
64+
- [OpenVox](/openvox/latest/) – open source, community-maintained implementation of Puppet
65+
- [OpenVox Server](/openvox-server/latest/)
66+
- [OpenVoxDB](/openvoxdb/latest/)
67+
68+
69+
### Share and contribute
70+
71+
- [Join us on Slack](https://voxpupuli.slack.com/) - Join the #bolt channel.
72+
- Follow us on [Bluesky](https://bsky.app/profile/voxpupuli.bsky.social/) or [Mastodon](https://fosstodon.org/@voxpupuli/)
73+
- [Connect with the OpenVox/VoxPupuli Community](https://voxpupuli.org/connect/)
74+
- [OpenVox on GitHub](https://github.com/openvox/)
75+
- [Open source projects from VoxPupuli on GitHub](https://github.com/voxpupuli/)
76+
- [Puppet Forge](https://forge.puppet.com) - Find modules you can use, and contribute modules you've made to the community.

0 commit comments

Comments
 (0)