Add OpenBolt documentation

.github/workflows/build.yaml

@@ -79,6 +79,7 @@ jobs:
         run: |
           bundle exec rake references:openfact INSTALLPATH=docs
           bundle exec rake references:openvox INSTALLPATH=docs
+          bundle exec rake references:openbolt INSTALLPATH=docs
           bundle exec jekyll build
       - name: Archive website
         run: |

.gitignore

@@ -1,5 +1,6 @@
 vendor
 vendor/puppet
+vendor/openbolt
 vendor/hiera
 vendor/facter
 vendor/bundle

Rakefile

@@ -30,6 +30,7 @@ task :references do
   puts 'The following references are available:'
   puts 'bundle exec rake references:openvox [VERSION=<GIT TAG OR COMMIT> INSTALLPATH=<RELATIVE OR ABSOLUTE PATH>]'
   puts 'bundle exec rake references:openfact [VERSION=<GIT TAG OR COMMIT> INSTALLPATH=<RELATIVE OR ABSOLUTE PATH>]'
+  puts 'bundle exec rake references:openbolt [VERSION=<GIT TAG OR COMMIT> INSTALLPATH=<RELATIVE OR ABSOLUTE PATH>]'
   puts 'bundle exec rake references:version_tables'
   puts '  VERSION can be omitted, uses latest tag'
   puts '  INSTALLPATH can be omitted, defaults to references_output/'
@@ -46,6 +47,11 @@ namespace :references do
     PuppetReferences.build_facter_references(ENV.fetch('VERSION', nil))
   end
 
+  task openbolt: 'references:check' do
+    require 'puppet_references'
+    PuppetReferences.build_openbolt_references(ENV.fetch('VERSION', nil))
+  end
+
   task :version_tables do
     require 'puppet_references'
     PuppetReferences.build_version_tables

_config.yml

@@ -61,6 +61,13 @@ collections:
     output: true
     permalink: '/openvoxdb/8.x/:path:output_ext'
 
+  openbolt_latest:
+    output: true
+    permalink: '/openbolt/latest/:path:output_ext'
+  openbolt_5x:
+    output: true
+    permalink: '/openbolt/5.x/:path:output_ext'
+
   openvox-containers_latest:
     output: true
     permalink: '/openvox-containers/latest/:path:output_ext'
@@ -110,6 +117,19 @@ defaults:
     values:
       nav: openvoxdb_8x
 
+  - scope:
+      path: ''
+      type: openbolt_latest
+    values:
+      layout: default
+      nav: openbolt_5x
+  - scope:
+      path: ''
+      type: openbolt_5x
+    values:
+      layout: default
+      nav: openbolt_5x
+
   - scope:
       path: ''
       type: openvox-containers_latest

_data/nav/openbolt_5x.yml

@@ -0,0 +1,135 @@
+---
+- text: Welcome to Puppet Bolt®
+  link: bolt.html
+  items:
+  - text: Developer updates
+    link: developer_updates.html
+  - text: Release notes
+    link: release_notes.html
+  - text: Bolt versioning
+    link: bolt_versioning.html
+  - text: Upgrading to Bolt 3.0
+    link: upgrading_to_bolt_3.html
+  - text: Known issues
+    link: bolt_known_issues.html
+- text: Installing Bolt
+  items:
+  - text: Installing Bolt
+    link: bolt_installing.html
+  - text: Run Bolt from a Docker image
+    link: running_bolt_in_docker.html
+- text: Getting started with Bolt
+  link: getting_started_with_bolt.html
+- text: Configuring Bolt
+  items:
+  - text: Bolt projects
+    link: projects.html
+  - text: Inventory files
+    link: inventory_files.html
+  - text: Configuring Bolt
+    link: configuring_bolt.html
+  - text: Logs
+    link: logs.html
+  - text: Escalating privilege with Bolt
+    link: privilege_escalation.html
+  - text: Setting up VS Code for Bolt
+    link: vscode_and_bolt.html
+- text: Running Bolt
+  items:
+  - text: Run Bolt
+    link: running_bolt_commands.html
+  - text: Run Bolt on network devices
+    link: running_bolt_network.html
+- text: Scripts
+  items:
+  - text: Running scripts
+    link: bolt_running_scripts.html
+  - text: Wrapping a script in a plan
+    link: creating_a_script_plan.html
+- text: Plans
+  link: plans.html
+  items:
+  - text: Inspecting plans
+    link: inspecting_plans.html
+  - text: Running plans
+    link: bolt_running_plans.html
+  - text: Writing plans in YAML
+    link: writing_yaml_plans.html
+  - text: Writing plans in the Puppet language
+    link: writing_plans.html
+  - text: Debugging plans
+    link: debugging_plans.html
+  - text: Testing plans
+    link: testing_plans.html
+- text: Tasks
+  link: tasks.html
+  items:
+  - text: Inspecting tasks
+    link: inspecting_tasks.html
+  - text: Running tasks
+    link: bolt_running_tasks.html
+  - text: Writing tasks
+    link: writing_tasks.html
+  - text: Task helpers
+    link: task_helpers.html
+- text: Modules
+  items:
+  - text: Modules overview
+    link: modules.html
+  - text: Installing modules
+    link: bolt_installing_modules.html
+  - text: Module structure
+    link: module_structure.html
+  - text: Packaged modules
+    link: packaged_modules.html
+- text: Plugins
+  items:
+  - text: Using plugins
+    link: using_plugins.html
+  - text: Supported plugins
+    link: supported_plugins.html
+  - text: Writing plugins
+    link: writing_plugins.html
+- text: Using Bolt with Puppet
+  items:
+  - text: Applying Puppet code
+    link: applying_manifest_blocks.html
+  - text: Using Bolt with Hiera
+    link: hiera.html
+  - text: Connecting Bolt to PuppetDB
+    link: bolt_connect_puppetdb.html
+- text: Bolt Examples
+  link: bolt_examples.html
+  items:
+  - text: Automating Windows targets
+    link: automating_windows_targets.html
+  - text: Deploy a TIG stack with Bolt
+    link: tig_stack.html
+- text: "\U0001F9EA Experimental features"
+  link: experimental_features.html
+- text: Reference
+  items:
+  - text: "*nix shell commands"
+    link: bolt_command_reference.html
+  - text: PowerShell cmdlets
+    link: bolt_cmdlet_reference.html
+  - text: JSON output
+    link: json_output_reference.html
+  - text: Plan functions
+    link: plan_functions.html
+  - text: Data types
+    link: bolt_types_reference.html
+  - text: Transport configuration options
+    link: bolt_transports_reference.html
+  - text: bolt-defaults.yaml options
+    link: bolt_defaults_reference.html
+  - text: bolt-project.yaml options
+    link: bolt_project_reference.html
+  - text: inventory.yaml fields
+    link: bolt_inventory_reference.html
+  - text: BoltSpec reference
+    link: boltspec_reference.html
+- text: Troubleshooting
+  link: troubleshooting.html
+- text: Glossary
+  link: glossary.html

_data/nav_map.yml

@@ -14,6 +14,10 @@
   collections: openvoxdb_latest|openvoxdb_8x
   base: /openvoxdb/latest/
 
+- nav_key: openbolt_5x
+  collections: openbolt_latest|openbolt_5x
+  base: /openbolt/latest/
+
 - nav_key: openvox-containers_latest
   collections: openvox-containers_latest
   base: /openvox-containers/latest/

_data/navigation.yml

@@ -10,6 +10,9 @@
 - title: OpenVoxDB
   url: /openvoxdb/latest/
   collections: [openvoxdb_latest, openvoxdb_8x]
+- title: OpenBolt
+  url: /openbolt/latest/
+  collections: [openbolt_latest, openbolt_5x]
 - title: OpenVox Containers
   url: /openvox-containers/latest/
   collections: [openvox-containers_latest]

docs/_openbolt_5x/.gitignore

@@ -0,0 +1,14 @@
+# ERB-generated reference pages — copied here by CI (bundle exec rake references:openbolt)
+bolt_cmdlet_reference.md
+bolt_command_reference.md
+bolt_defaults_reference.md
+bolt_project_reference.md
+bolt_transports_reference.md
+bolt_types_reference.md
+packaged_modules.md
+plan_functions.md
+privilege_escalation.md
+*.png
+*.jpg
+*.gif
+*.svg

docs/_openbolt_5x/.markdownlint.yaml

@@ -0,0 +1,86 @@
+---
+# Ported from upstream Puppet Bolt docs. These rules fire extensively across
+# the imported content but do not reflect errors in meaning or structure.
+# TODO: fix violations and remove this file — https://github.com/OpenVoxProject/openvox-docs/issues/199
+
+# MD060: 260 violations — table columns not padded to aligned_delimiter width
+table-column-style: false
+
+# MD009: 136 violations — trailing spaces throughout source
+no-trailing-spaces: false
+
+# MD031: 132 violations — fenced code blocks missing surrounding blank lines
+blanks-around-fences: false
+
+# MD030: 132 violations — extra spaces after list markers (e.g. "-  item")
+list-marker-space: false
+
+# MD040: 123 violations — fenced code blocks without a language specifier
+fenced-code-language: false
+
+# MD036: 120 violations — bold/italic used as informal headings
+no-emphasis-as-heading: false
+
+# MD033: 86 violations — inline HTML beyond what the root config permits
+no-inline-html: false
+
+# MD032: 64 violations — lists not surrounded by blank lines
+blanks-around-lists: false
+
+# MD049: 26 violations — inconsistent emphasis delimiter (* vs _)
+emphasis-style: false
+
+# MD004: 22 violations — inconsistent unordered list markers
+ul-style: false
+
+# MD007: 18 violations — unordered list indentation
+ul-indent: false
+
+# MD027: 13 violations — multiple spaces after blockquote marker
+no-multiple-space-blockquote: false
+
+# MD014: 11 violations — shell commands with $ prefix followed by output
+commands-show-output: false
+
+# MD013: 9 violations — lines exceeding the 210-char root limit
+line-length: false
+
+# MD051: 6 violations — link fragments referencing headings that don't exist
+link-fragments: false
+
+# MD055: 4 violations — inconsistent table pipe style
+table-pipe-style: false
+
+# MD047: 4 violations — files missing a trailing newline
+single-trailing-newline: false
+
+# MD045: 4 violations — images without alt text
+no-alt-text: false
+
+# MD034: 4 violations — bare URLs
+no-bare-urls: false
+
+# MD029: 4 violations — ordered list prefix style
+ol-prefix: false
+
+# MD022: 4 violations — headings not surrounded by blank lines
+blanks-around-headings: false
+
+# MD056: 1 violation — inconsistent column count across table rows
+table-column-count: false
+
+# MD028: 1 violation — blank line inside block quote
+no-blanks-blockquote: false
+
+# MD010: 1 violation — hard tabs
+no-hard-tabs: false
+
+# MD012: violations — multiple consecutive blank lines (root config alias not recognized)
+no-multiple-blanks:
+  maximum: 2
+
+# MD024: duplicate headings that are siblings (e.g. repeated language-specific task sections)
+no-duplicate-heading: false
+
+# MD025: multiple H1 headings in a document
+single-title: false