Skip to content

Commit dc2da93

Browse files
miharpclaude
miharp
and
claude
committed
Add OpenBolt documentation
Adds a rake task, Jekyll collection, sidebar nav, and CI build step to serve the OpenBolt documentation on the docs site. At CI time, `rake references:openbolt INSTALLPATH=docs` clones OpenVoxProject/openbolt, checks out the latest tag, copies all markdown and image files from its `documentation/` directory into `docs/_openbolt_5x/` (via the `_openbolt_latest` symlink), and prepends Jekyll frontmatter to each page. Resolves #98. Signed-off-by: Michael Harp <mike@mikeharp.com> Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 0469c3c commit dc2da93

12 files changed

Lines changed: 269 additions & 0 deletions

File tree

‎.github/workflows/build.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@ jobs:
7979
run: |
8080
bundle exec rake references:openfact INSTALLPATH=docs
8181
bundle exec rake references:openvox INSTALLPATH=docs
82+
bundle exec rake references:openbolt INSTALLPATH=docs
8283
bundle exec jekyll build
8384
- name: Archive website
8485
run: |

‎Rakefile‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ task :references do
3030
puts 'The following references are available:'
3131
puts 'bundle exec rake references:openvox [VERSION=<GIT TAG OR COMMIT> INSTALLPATH=<RELATIVE OR ABSOLUTE PATH>]'
3232
puts 'bundle exec rake references:openfact [VERSION=<GIT TAG OR COMMIT> INSTALLPATH=<RELATIVE OR ABSOLUTE PATH>]'
33+
puts 'bundle exec rake references:openbolt [VERSION=<GIT TAG OR COMMIT> INSTALLPATH=<RELATIVE OR ABSOLUTE PATH>]'
3334
puts 'bundle exec rake references:version_tables'
3435
puts ' VERSION can be omitted, uses latest tag'
3536
puts ' INSTALLPATH can be omitted, defaults to references_output/'
@@ -46,6 +47,11 @@ namespace :references do
4647
PuppetReferences.build_facter_references(ENV.fetch('VERSION', nil))
4748
end
4849

50+
task openbolt: 'references:check' do
51+
require 'puppet_references'
52+
PuppetReferences.build_openbolt_references(ENV.fetch('VERSION', nil))
53+
end
54+
4955
task :version_tables do
5056
require 'puppet_references'
5157
PuppetReferences.build_version_tables

‎_config.yml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,13 @@ collections:
6161
output: true
6262
permalink: '/openvoxdb/8.x/:path:output_ext'
6363

64+
openbolt_latest:
65+
output: true
66+
permalink: '/openbolt/latest/:path:output_ext'
67+
openbolt_5x:
68+
output: true
69+
permalink: '/openbolt/5.x/:path:output_ext'
70+
6471
defaults:
6572
- scope:
6673
path: ''
@@ -106,6 +113,17 @@ defaults:
106113
values:
107114
nav: openvoxdb_8x
108115

116+
- scope:
117+
path: ''
118+
type: openbolt_latest
119+
values:
120+
nav: openbolt_5x
121+
- scope:
122+
path: ''
123+
type: openbolt_5x
124+
values:
125+
nav: openbolt_5x
126+
109127

110128
# Ignores all legacy files present in the root directory as of
111129
# commit 09952f27 (with the exception of LICENSE). As older files

‎_data/nav/openbolt_5x.yml‎

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
---
2+
- text: Overview
3+
items:
4+
- text: Welcome to OpenBolt
5+
link: index.html
6+
- text: Getting started
7+
link: getting_started_with_bolt.html
8+
- text: Versioning
9+
link: bolt_versioning.html
10+
- text: Known issues
11+
link: bolt_known_issues.html
12+
- text: Troubleshooting
13+
link: troubleshooting.html
14+
- text: Upgrading to Bolt 3
15+
link: upgrading_to_bolt_3.html
16+
- text: Glossary
17+
link: glossary.html
18+
- text: Installation
19+
items:
20+
- text: Installing Bolt
21+
link: bolt_installing.html
22+
- text: Running Bolt in Docker
23+
link: running_bolt_in_docker.html
24+
- text: VS Code and Bolt
25+
link: vscode_and_bolt.html
26+
- text: Configuration
27+
items:
28+
- text: Configuring Bolt
29+
link: configuring_bolt.html
30+
- text: Projects
31+
link: projects.html
32+
- text: Inventory files
33+
link: inventory_files.html
34+
- text: Inventory reference
35+
link: bolt_inventory_reference.html
36+
- text: Hiera
37+
link: hiera.html
38+
- text: Supported plugins
39+
link: supported_plugins.html
40+
- text: Commands and scripts
41+
items:
42+
- text: Running Bolt commands
43+
link: running_bolt_commands.html
44+
- text: Running scripts
45+
link: bolt_running_scripts.html
46+
- text: Running Bolt over a network
47+
link: running_bolt_network.html
48+
- text: Tasks
49+
items:
50+
- text: Introduction to tasks
51+
link: tasks.html
52+
- text: Running tasks
53+
link: bolt_running_tasks.html
54+
- text: Writing tasks
55+
link: writing_tasks.html
56+
- text: Inspecting tasks
57+
link: inspecting_tasks.html
58+
- text: Task helpers
59+
link: task_helpers.html
60+
- text: Plans
61+
items:
62+
- text: Introduction to plans
63+
link: plans.html
64+
- text: Running plans
65+
link: bolt_running_plans.html
66+
- text: Writing plans
67+
link: writing_plans.html
68+
- text: Writing YAML plans
69+
link: writing_yaml_plans.html
70+
- text: Creating a script plan
71+
link: creating_a_script_plan.html
72+
- text: Inspecting plans
73+
link: inspecting_plans.html
74+
- text: Debugging plans
75+
link: debugging_plans.html
76+
- text: Testing plans
77+
link: testing_plans.html
78+
- text: Applying manifest blocks
79+
link: applying_manifest_blocks.html
80+
- text: Modules
81+
items:
82+
- text: Modules
83+
link: modules.html
84+
- text: Module structure
85+
link: module_structure.html
86+
- text: Installing modules
87+
link: bolt_installing_modules.html
88+
- text: Plugins
89+
items:
90+
- text: Using plugins
91+
link: using_plugins.html
92+
- text: Writing plugins
93+
link: writing_plugins.html
94+
- text: Reference
95+
items:
96+
- text: Bolt spec reference
97+
link: boltspec_reference.html
98+
- text: JSON output reference
99+
link: json_output_reference.html
100+
- text: Connecting to PuppetDB
101+
link: bolt_connect_puppetdb.html
102+
- text: Choria transport
103+
link: choria-transport.html
104+
- text: Automating Windows targets
105+
link: automating_windows_targets.html
106+
- text: Analytics
107+
link: analytics.html
108+
- text: Experimental features
109+
link: experimental_features.html
110+
- text: Logs
111+
link: logs.html
112+
- text: TIG stack
113+
link: tig_stack.html
114+
- text: Developer updates
115+
link: developer_updates.html
116+
- text: Examples
117+
link: bolt_examples.html

‎_data/nav_map.yml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,7 @@
1313
- nav_key: openvoxdb_8x
1414
collections: openvoxdb_latest|openvoxdb_8x
1515
base: /openvoxdb/latest/
16+
17+
- nav_key: openbolt_5x
18+
collections: openbolt_latest|openbolt_5x
19+
base: /openbolt/latest/

‎_data/navigation.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,6 @@
1010
- title: OpenVoxDB
1111
url: /openvoxdb/latest/
1212
collections: [openvoxdb_latest, openvoxdb_8x]
13+
- title: OpenBolt
14+
url: /openbolt/latest/
15+
collections: [openbolt_latest, openbolt_5x]

‎docs/_openbolt_5x/.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
*
2+
!.gitignore
3+
!.gitkeep

‎docs/_openbolt_5x/.gitkeep‎

Whitespace-only changes.

‎docs/_openbolt_latest‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
_openbolt_5x

‎index.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,11 @@ features:
3030
title: OpenVox DB
3131
details: OpenVoxDB is the fast, scalable, and reliable data warehouse for OpenVox.
3232
link: openvoxdb/latest/
33+
34+
- icon: 🔩
35+
title: OpenBolt
36+
details: OpenBolt is an open source orchestration tool that automates on-demand changes to remote targets such as servers, network devices, and cloud services.
37+
link: openbolt/latest/
3338
---
3439

3540
{% include alert.html type="warning" title="Under Construction" content="The contents of this documentation site are currently being re-built from various upstream sources. Links may be broken and some version information may be out of date. Pardon the mess as we get things cleaned up!" %}

0 commit comments

Comments
 (0)