Skip to content

docs: fix broken hiera links in the openvox collection - #281

Merged
tuxmea merged 2 commits into
OpenVoxProject:masterfrom
miharp:docs/issue-225-hiera-links
Jun 1, 2026
Merged

tuxmea merged 2 commits into
OpenVoxProject:masterfrom
miharp:docs/issue-225-hiera-links

Conversation

@miharp

@miharp miharp commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

What

Fixes the broken internal links on the Hiera config pages. Four pages linked to reference pages that were never migrated into the openvox collection — hiera_hierarchy.html, hiera_layers.html, hiera_interpolation.html, and lookup_types.html (none of which exist here). This repoints each to the equivalent section that does exist, following the same pattern hiera_config_yaml_5 already uses for its [hierarchy]/[layers] refs:

Old (missing) target New target
hiera_hierarchy.html hiera_intro.html#hiera-hierarchies
hiera_layers.html hiera_intro.html#hieras-three-config-layers
hiera_layers.html (module data) hiera_intro.html#the-module-layer
hiera_interpolation.html hiera_merging.html#interpolation
lookup_types.html#hash-merge hiera_merging.html#hash
lookup_types.html#deep-merging-in-hiera hiera_merging.html#deep

Files touched: hiera_config_yaml_3, hiera_config_yaml_4, hiera_config_yaml_5, modules_metadata.

Why

Part of the broken-internal-link cleanup (#262). These were the remaining hiera link failures in the openvox collection (13 failing link instances across the four pages).

Verification

  • All six rendered target anchors confirmed present in the built hiera_intro.html / hiera_merging.html.
  • Scoped htmlproofer run reports the four edited pages clean and no remaining references to the four un-migrated target pages.

This addresses the broken-link portion of #225; the nav and obsolete-content items in that issue are out of scope here.

Part of #225
Part of #262

Four hiera pages linked to reference pages that were never migrated into
the openvox collection (hiera_hierarchy, hiera_layers, hiera_interpolation,
lookup_types). Repoint these to the equivalent sections that do exist,
following the pattern already used in hiera_config_yaml_5:

- hierarchy -> hiera_intro.html#hiera-hierarchies
- layers    -> hiera_intro.html#hieras-three-config-layers
- module data (module layer) -> hiera_intro.html#the-module-layer
- interpolation -> hiera_merging.html#interpolation
- hash/deep merge -> hiera_merging.html#hash and #deep

Affects hiera_config_yaml_3, hiera_config_yaml_4, hiera_config_yaml_5, and
modules_metadata. Verified the rendered target anchors resolve and the four
pages are htmlproofer-clean.

Part of OpenVoxProject#262

Signed-off-by: Michael Harp <mike@mikeharp.com>
@miharp
miharp requested a review from a team as a code owner June 1, 2026 13:22
@tuxmea
tuxmea merged commit 31309ed into OpenVoxProject:master Jun 1, 2026
4 checks passed
@miharp
miharp deleted the docs/issue-225-hiera-links branch June 23, 2026 14:11
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.

2 participants