Add htmlproofer CI workflow (advisory)#120
Closed
miharp wants to merge 1 commit intoOpenVoxProject:masterfrom
Closed
Add htmlproofer CI workflow (advisory)#120miharp wants to merge 1 commit intoOpenVoxProject:masterfrom
miharp wants to merge 1 commit intoOpenVoxProject:masterfrom
Conversation
This was referenced Apr 29, 2026
2 tasks
miharp
added a commit
to miharp/openvox-docs
that referenced
this pull request
May 1, 2026
Inline links in _openvox-server_8x and _openvoxdb_8x used .markdown extensions which Jekyll renders as .html. PR OpenVoxProject#119 fixed this in _openvox_8x; this extends the same fix to the remaining two collections. 22 files updated across both collections. Part of the link debt being surfaced by OpenVoxProject#120. Signed-off-by: Michael Harp <mike@mikeharp.com> Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This was referenced May 1, 2026
tuxmea
approved these changes
May 1, 2026
miharp
added a commit
to miharp/openvox-docs
that referenced
this pull request
May 1, 2026
Inline links in _openvox-server_8x and _openvoxdb_8x used .markdown extensions which Jekyll renders as .html. PR OpenVoxProject#119 fixed this in _openvox_8x; this extends the same fix to the remaining two collections. 22 files updated across both collections. Part of the link debt being surfaced by OpenVoxProject#120. Signed-off-by: Michael Harp <mike@mikeharp.com> Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
miharp
added a commit
to miharp/openvox-docs
that referenced
this pull request
May 1, 2026
Inline links in _openvox-server_8x and _openvoxdb_8x used .markdown extensions which Jekyll renders as .html. PR OpenVoxProject#119 fixed this in _openvox_8x; this extends the same fix to the remaining two collections. 22 files updated across both collections. Part of the link debt being surfaced by OpenVoxProject#120. Signed-off-by: Michael Harp <mike@mikeharp.com> Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
miharp
added a commit
to miharp/openvox-docs
that referenced
this pull request
May 1, 2026
htmlproofer flags <a> tags without href attributes. Replace legacy named anchor patterns with <span id="..."></span> which is the correct HTML5 approach for bookmark targets. - lang_variables.markdown: 5 nested <a id="..."> tags - ha.markdown: 1 <a name="..."> tag Fixes 12 htmlproofer failures. Part of OpenVoxProject#120. Signed-off-by: Michael Harp <mike@mikeharp.com> Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Adds htmlproofer to the CI pipeline to catch broken internal links on every PR and push to master. Runs in advisory mode (continue-on-error: true) due to inherited link debt from the Puppet docs migration. - Internal links only (--disable-external) to avoid third-party flakiness - Ignores legacy /puppet/, /pe/, /puppetlabs/ URL prefixes - Pinned to ubuntu-24.04 and actions/checkout@v4 to match test.yml Signed-off-by: Michael Harp <mike@mikeharp.com> Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Contributor
Author
|
Closing for now — the pre-existing failure count (~1006) makes the advisory output too noisy to be useful. Generated reference files not being present on PR builds also causes false positives. Will revisit once the broken link backlog is in better shape. |
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
2 participants
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 htmlproofer to the CI pipeline to catch broken internal links on every PR and push to master.
Currently runs in advisory mode (
continue-on-error: true) due to significant inherited link debt from the Puppet docs migration. Will be made enforced once the outstanding issues are resolved.What it checks
--disable-external) — avoids flakiness from third-party sites going down/puppet/,/pe/,/puppetlabs/) that appear in inherited content_site/directoryKnown outstanding failures (advisory until fixed)
.markdownref-style link definitions.htmllinks to deleted/missing pages.mdextension linksRoadmap to enforcement
.markdownand.mdedge cases.htmllinks (deleted man pages, missing hiera pages)continue-on-errortofalse