Add OpenBolt documentation#143
Merged
Merged
Conversation
miharp
force-pushed
the
feat/add-openbolt-docs
branch
3 times, most recently
from
fd2ae9e to
74e3eb3
Compare
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 OpenVoxProject#98. Signed-off-by: Michael Harp <mike@mikeharp.com> Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
miharp
force-pushed
the
feat/add-openbolt-docs
branch
from
74e3eb3 to
dc2da93
Compare
tuxmea
approved these changes
May 2, 2026
bastelfreak
reviewed
May 2, 2026
| link: bolt_known_issues.html | ||
| - text: Troubleshooting | ||
| link: troubleshooting.html | ||
| - text: Upgrading to Bolt 3 |
Contributor
There was a problem hiding this comment.
Bolt 3 is really ancient and it doesn't apply to any openbolt version. Should we get rid of it?
This was referenced May 2, 2026
tuxmea
pushed a commit
that referenced
this pull request
May 2, 2026
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>
tuxmea
added a commit
that referenced
this pull request
May 2, 2026
Revert "Add OpenBolt documentation" (#143)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
rake references:openbolttask that clonesOpenVoxProject/openbolt, checks out the latest tag, and copies all docs and images from itsdocumentation/directory intodocs/_openbolt_5x/with Jekyll frontmatteropenbolt_5x/openbolt_latestcollections in_config.yml,_data/nav_map.yml, and_data/navigation.yml_data/nav/openbolt_5x.ymlwith pages organised into sectionsrake references:openbolt INSTALLPATH=docsinto the CI build step alongside the existing openvox/openfact tasksCloses #98.
Nav maintenance note
_data/nav/openbolt_5x.ymlis hand-authored and not generated by the rake task. If pages are added, renamed, or removed in the upstreamOpenVoxProject/openboltdocumentation/directory, this file will need a corresponding manual update to keep the sidebar accurate.Test plan
bundle exec rubocop lib/puppet_references/openbolt/docs.rb— no offensesbundle exec rake references:openbolt— clones repo, generates 49 pages + 4 images intoreferences_output/_openbolt_latest/bundle exec rake references:openbolt INSTALLPATH=docs— files land correctly indocs/_openbolt_5x/via symlinkbundle exec jekyll build— clean build, pages served at/openbolt/latest/and/openbolt/5.x//openbolt/latest/docs/_openbolt_5x/.gitignore