Skip to content

docs: fix drifted anchors to existing pages in openvox 8x (#262 F)#272

Merged
tuxmea merged 1 commit into
OpenVoxProject:masterfrom
miharp:docs/issue-262-anchor-fixes
May 31, 2026
Merged

docs: fix drifted anchors to existing pages in openvox 8x (#262 F)#272
tuxmea merged 1 commit into
OpenVoxProject:masterfrom
miharp:docs/issue-262-anchor-fixes

Conversation

@miharp
Copy link
Copy Markdown
Contributor

@miharp miharp commented May 31, 2026

What

Fixes links whose target page exists but whose #fragment drifted — workstream F of #262. Each new anchor was verified against the built page's actual kramdown id (htmlproofer … --checks Links).

Anchor renames (link → current id)

Target page Old New
lang_relationships #chaining-arrows / #relationship-metaparameters #syntax-chaining-arrows / #syntax-relationship-metaparameters
lang_facts_and_builtin_vars #serverfacts-variable / #the-factsfactname-hash #server_facts-variable / #the-factsfact_name-hash
modules_fundamentals #files #files-in-modules
function #asserttype #assert_type
install_windows #puppetagentaccountuser #puppet_agent_account_user
config_about_settings #settings-can-be-set-on-the-command-line #settings-on-the-command-line
architecture #note-differences-between-agentmaster-and-puppet-apply #differences-between-agent-server-and-stand-alone
style_guide #module-documentation #documentation
modules_metadata …requirements-in-module …requirements-in-modules
modules_installing #installing-modules #installing-modules-from-the-command-line
quick_start_firewall …myfirewall… …my_firewall…

Plus two repoints where the original section was removed/restructured:

lang_expressions operator headings

The comparison/arithmetic/hash operator headings start with a code span (e.g. ### \==` (equality)), so kramdown auto-generated **leading-hyphen ids** (-equality, --subtraction-and-negation, -splat, …) that the clean-form inbound links never matched. Added explicit {#equality}, {#regex-or-data-type-match}, {#subtraction-and-negation}, {#splat}, {#merging}` so the links resolve and the anchors are stable.

Verification

htmlproofer _site/openvox/latest --disable-external --checks Links: all F-scope anchor failures resolved. jekyll build clean. Diff is anchor-only (16 files, 25/25 lines).

Out of scope (remaining hash failures, for E / content cleanup)

  • Moved core types — type.html#cron / #host / #mount / #scheduledtask + the cron-attribute-* family (now in the puppetlabs-*_core modules, not core type.html).
  • Removed settings — configuration.html#ca / #ordering / #capass / etc.
  • The removed LDAP node terminus (indirection.html#ldap-terminus).
  • Two cross-collection openvox-server anchors.

Part of #262

…VoxProject#262 F)

Repoint links whose target page exists but whose #fragment drifted
(workstream F of OpenVoxProject#262). Verified each against the built page's actual
kramdown ids.

Anchor renames (link → current id):
- lang_relationships: #chaining-arrows → #syntax-chaining-arrows;
  #relationship-metaparameters → #syntax-relationship-metaparameters
- lang_facts_and_builtin_vars: #serverfacts-variable → #server_facts-variable;
  #the-factsfactname-hash → #the-factsfact_name-hash
- modules_fundamentals: #files → #files-in-modules
- function: #asserttype → #assert_type
- install_windows: #puppetagentaccountuser → #puppet_agent_account_user
- config_about_settings: #settings-can-be-set-on-the-command-line →
  #settings-on-the-command-line
- architecture: #note-differences-between-agentmaster-and-puppet-apply →
  #differences-between-agent-server-and-stand-alone
- style_guide: #module-documentation → #documentation
- modules_metadata: #...requirements-in-module → #...requirements-in-modules
- modules_installing: #installing-modules → #installing-modules-from-the-command-line
- quick_start_firewall: #...myfirewall... → #...my_firewall...
- ssl_attributes_extensions: subsystem_agent_server_comm.html#check-for-keys-and-certificates
  → the page's current section id (page restructured in OpenVoxProject#256)
- config_important_settings: static-compiler link repointed from the removed
  indirection.html#staticcompiler-terminus to the static_catalogs page

lang_expressions: the comparison/arithmetic/hash operator headings start with
a code span (e.g. "### `==` (equality)"), so kramdown generated leading-hyphen
ids (`-equality`, `--subtraction-and-negation`). Added explicit `{#equality}`,
`{#regex-or-data-type-match}`, `{#subtraction-and-negation}`, `{#splat}`,
`{#merging}` so the (clean-form) inbound links resolve and the anchors are
stable.

Verified with htmlproofer against _site/openvox/latest: all F-scope hash
failures resolved. Remaining hash failures are out of scope (moved core types
type.html#cron/#host/#mount/#scheduledtask now in *_core modules; removed
settings like configuration.html#ca/#ordering; the removed LDAP node terminus;
two cross-collection openvox-server anchors).

Part of OpenVoxProject#262

Signed-off-by: Michael Harp <mike@mikeharp.com>
@miharp miharp requested a review from a team as a code owner May 31, 2026 16:20
@tuxmea tuxmea merged commit ca9c00f into OpenVoxProject:master May 31, 2026
4 checks passed
@miharp miharp deleted the docs/issue-262-anchor-fixes branch May 31, 2026 19:33
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