Skip to content

Commit 0045a03

Browse files
miharpclaude
andcommitted
Revert "Add OpenBolt documentation" (#143)
Reverts #143 while the following issues are resolved: 1. **Broken internal links (94):** The bolt documentation references several pages that are generated from ERB templates in `documentation/templates/` rather than existing as static markdown. These pages — including `plan_functions.md`, `bolt_types_reference.md`, `bolt_transports_reference.md`, `bolt_project_reference.md`, `bolt_defaults_reference.md`, `bolt_command_reference.md`, `bolt_cmdlet_reference.md`, and `packaged_modules.md` — are absent from the copy pipeline, leaving 94 internal links as 404s. 2. **Relative .md links:** The upstream docs use relative `.md` links for cross-references. Jekyll serves the collection as `.html`, so those links also 404 without a rewrite step in the pipeline (tracked in #144). A follow-up PR will address both issues before re-landing the OpenBolt docs. Signed-off-by: Michael Harp <mike@mikeharp.com> Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 4dc2842 commit 0045a03

12 files changed

Lines changed: 0 additions & 269 deletions

File tree

.github/workflows/build.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,6 @@ 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
8382
bundle exec jekyll build
8483
- name: Archive website
8584
run: |

Rakefile

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@ 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>]'
3433
puts 'bundle exec rake references:version_tables'
3534
puts ' VERSION can be omitted, uses latest tag'
3635
puts ' INSTALLPATH can be omitted, defaults to references_output/'
@@ -47,11 +46,6 @@ namespace :references do
4746
PuppetReferences.build_facter_references(ENV.fetch('VERSION', nil))
4847
end
4948

50-
task openbolt: 'references:check' do
51-
require 'puppet_references'
52-
PuppetReferences.build_openbolt_references(ENV.fetch('VERSION', nil))
53-
end
54-
5549
task :version_tables do
5650
require 'puppet_references'
5751
PuppetReferences.build_version_tables

_config.yml

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -61,13 +61,6 @@ 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-
7164
defaults:
7265
- scope:
7366
path: ''
@@ -113,17 +106,6 @@ defaults:
113106
values:
114107
nav: openvoxdb_8x
115108

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-
127109

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

_data/nav/openbolt_5x.yml

Lines changed: 0 additions & 117 deletions
This file was deleted.

_data/nav_map.yml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,3 @@
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: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,3 @@
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: 0 additions & 3 deletions
This file was deleted.

docs/_openbolt_5x/.gitkeep

Whitespace-only changes.

docs/_openbolt_latest

Lines changed: 0 additions & 1 deletion
This file was deleted.

index.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,6 @@ 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/
3833
---
3934

4035
{% 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)