Add legacy docs variable compatibility shim#116
Draft
miharp wants to merge 2 commits intoOpenVoxProject:masterfrom
Draft
Add legacy docs variable compatibility shim#116miharp wants to merge 2 commits intoOpenVoxProject:masterfrom
miharp wants to merge 2 commits intoOpenVoxProject:masterfrom
Conversation
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
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
Adds a small Jekyll plugin that restores the simple inherited Puppet docs variables during rendering, and fixes the remaining Hiera references directly in the six affected OpenVox markdown pages.
The plugin now only injects
puppet,puppetserver,puppetdb, andfacterinto the Liquid render payload. Hiera links are direct source edits. PE-specific links/callouts are intentionally left out of scope for a future PR.Why
The inherited Puppet docs source still uses bare Liquid variables like
{{puppetserver}},{{facter}}, and{{puppetdb}}. In this site they are undefined, so Jekyll renders them as empty strings and produces broken links such as/services_master_puppetserver.html.Hiera references only appear in six source files, so those were fixed directly and made markdownlint-clean. The generated type docs remain untouched for #114.
Fixes #115.
Validation
bundle exec jekyll buildgit diff --checknpx --yes markdownlint-cli2 docs/_openvox_8x/lang_summary.markdown docs/_openvox_8x/lang_node_definitions.markdown docs/_openvox_8x/lang_classes.markdown docs/_openvox_8x/hiera_config_yaml_3.md docs/_openvox_8x/system_requirements.markdown docs/_openvox_8x/services_commands.markdown{{puppetserver}},{{facter}},{{puppetdb}},{{puppet}}, or{{hiera}}variables remain under_site/openvox/latestor_site/openvox/8.x/openvox/latest/services_commands.htmlrenders fixed Puppet Server, Facter, and Hiera linksRollback note
The first commit (
e30528bf9) is the plugin-only rollback point. The second commit (95693cbb6) contains the direct Hiera markdown edits and lint cleanup.