Skip to content

docs: fix Hiera nav label and stale deprecation content#310

Merged
1 commit merged into
OpenVoxProject:masterfrom
miharp:docs/issue-225-hiera
Jun 8, 2026
Merged

docs: fix Hiera nav label and stale deprecation content#310
1 commit merged into
OpenVoxProject:masterfrom
miharp:docs/issue-225-hiera

Conversation

@miharp

@miharp miharp commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

What

Small Hiera documentation cleanups.

  • Nav: rename the duplicate "Hiera" item (under the "Hiera" section header) to "About Hiera" in _data/nav/openvox_8x.yml.
  • Stale deprecation language: hiera_config_yaml_3.md and hiera_config_yaml_4.md said v3/v4 would have "support removed in Puppet 6" (long EOL). Reworded to reflect reality — these formats are deprecated and not recommended, but OpenVox 8.x still supports them for backward compatibility (use v5 instead).
  • hiera_migrate.md: added a short note that Hiera 5 has been the default since Puppet 5 (2017), so most OpenVox 8.x users don't need the migration guide. Kept the page (the site has no redirect mechanism, so deleting it would 404 the old URL).

Notes

Verified the issue's other claims before working it (see #225): the "broken links" were already resolved (reference labels resolve to existing anchors), and a proposed puppet lookup nav entry was dropped as redundant with the existing "Looking up data with Hiera" page.

Passes jekyll build and the internal link check. markdownlint changes are confined to modified files (advisory) with no new errors introduced.

Closes #225

- nav: rename the duplicate "Hiera" item to "About Hiera"
- hiera_config_yaml_3/4: replace the stale "remove support in Puppet 6"
  notices with accurate text (deprecated, still supported in 8.x for
  backward compatibility, use v5)
- hiera_migrate: add a note that Hiera 5 is the default since Puppet 5
  and most 8.x users do not need the migration guide

Signed-off-by: Michael Harp <mike@mikeharp.com>
Assisted-by: Claude Opus 4.8
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@miharp miharp requested a review from a team as a code owner June 8, 2026 12:09

@cvquesty cvquesty left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aside from a small amount of line-length complaining by markdown-lint,, this LGTM

@corporate-gadfly corporate-gadfly closed this pull request by merging all changes into OpenVoxProject:master in 037aba4 Jun 8, 2026
@miharp miharp deleted the docs/issue-225-hiera branch June 8, 2026 14:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Hiera docs: nav labels and stale content

3 participants