Skip to content

Hiera docs: broken links, nav issues, and obsolete content #225

@miharp

Description

@miharp

Summary

A review of the Hiera documentation section against both the existing content and Puppet Core 8 docs revealed several issues ranging from broken links to obsolete content.

Broken internal links

Three pages are referenced across the Hiera docs but do not exist:

  • hiera_hierarchy.html — linked from hiera_config_yaml_3.md and hiera_config_yaml_4.md
  • hiera_interpolation.html — linked from hiera_config_yaml_3.md and hiera_config_yaml_5.md
  • hiera_layers.html — linked from hiera_config_yaml_3.md and hiera_config_yaml_4.md

These appear to be pages that were consolidated into hiera_intro.md at some point without updating the links.

Nav: duplicate "Hiera" label

In _data/nav/openvox_8x.yml, the Hiera section header and the first nav item both read "Hiera". The item linking to hiera_intro.html should have a distinct label such as "About Hiera" or "Overview".

Nav: no "Debugging Hiera" entry

Puppet Core 8 docs surface puppet lookup debugging as its own nav item. OpenVox has equivalent content in hiera_automatic.md (line 125, "Using puppet lookup") but it's buried mid-page with no nav entry. This should either be split into a dedicated page or surfaced via a nav anchor link.

Obsolete deprecation language

hiera_config_yaml_3.md and hiera_config_yaml_4.md both contain deprecation notices saying "we plan to remove support for it in Puppet 6." Puppet 6 is long past and OpenVox 8.x does not support Hiera 3 or 4 at all. The language should be updated to state these formats are unsupported in OpenVox 8.x.

hiera_migrate.md is obsolete

The "Upgrading to Hiera 5" page (507 lines) covers migration from Hiera 3 → 5. No OpenVox 8.x user needs this guidance — Hiera 5 has been the default since Puppet 5 (2017). This page should be removed, with a redirect added if the site infrastructure supports it.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions