Repository navigation
Conversation
Nothing built or validated docs/sources in CI, so a broken relref in a docs page was only caught by the website build after merge. The new workflow runs the existing `make -C docs test` target, which is Hugo with HUGO_REFLINKSERRORLEVEL=ERROR, path-filtered to docs changes. The two DOC_VALIDATOR_* exports in docs/variables.mk read their values out of .github/workflows/test.yml, which does not exist in this repo, so both have always been empty. There is also no doc-validator target in docs.mk to consume them, and no sibling repo runs doc-validator per-repo. They were copied from a template, so remove them rather than leave config that looks live and asserts parity with CI that was never there. Adding real doc-validator coverage is a separate decision, not implied by deleting config that never worked.
sd2k
approved these changes
Sep 16, 2026
This branch has not been deployed
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
Docsworkflow that runs the existingmake -C docs testtarget (Hugo withHUGO_REFLINKSERRORLEVEL=ERROR), path-filtered todocs/**. Nothing built or validateddocs/sourcesin CI before this, so a broken relref was only caught by the website build after merge.DOC_VALIDATOR_*exports fromdocs/variables.mk.Why
docs/variables.mkreads both values out of.github/workflows/test.yml:That file does not exist in this repo, so
sedsilently yields nothing and both variables have always been empty. There is also nodoc-validatortarget indocs.mkto consume them, and neithergrafana/grafananorgrafana/gcxruns doc-validator per-repo — gcx'svariables.mkhas no such lines at all. They were copied from a template.I removed them rather than pointing them at something real: config that looks live and claims parity with a CI job that was never there is worse than no config. Adding actual doc-validator coverage is a separate decision and this PR deliberately doesn't make it — it would be a new gate no sibling repo has, and it should be chosen rather than smuggled in under a cleanup.
docs.mkis upstream-managed by Writers' Toolkit (see itsupdatetarget), so I haven't touched it.Verified
make -C docs testpasses onmainbefore the change and on this branch after it — 568 pages, no errors — so the new job is green from the start rather than landing red.One thing to decide: the job is path-filtered, so if you ever make it a required check, a PR touching no docs will show it as skipped. That's fine for an optional check, worth knowing before making it required.
Found while adding the usage-statistics docs page in #1188, which this is independent of.