Skip to content

improve link-validation action #2879

Closed

Description

@jan--f

I ran the new link-validation action for the first time. We should update the jobs config somewhat to ignore repo-local links, e.g.:

docs/guides/file-sd.md:5: link /docs/prometheus/latest/configuration/configuration/#kubernetes_sd_config, normalized to: /home/runner/work/docs/docs/docs/prometheus/latest/configuration/configuration: file not found

as well as tutorial links to localhost like

docs/guides/multi-target-exporter.md:290: "http://localhost:9115" not accessible even after retry; status code 0: Get "http://localhost:9115": dial tcp [::1]:9115: connect: connection refused

Activity

  1. kkukadia commented on Mar 31, 2026

    @kkukadia

    I'd like to work on this. Planning to update .mdox.validator.yaml to ignore the absolute website paths and localhost URLs. Will test locally first and open a PR.

  2. kkukadia commented on Mar 31, 2026

    @kkukadia

    here's what I found so far: turning on a flag in mdox called explicitLocalValidators routes local paths through the validator config, and adds an ignore rule for absolute paths starting with /. The flag was added to mdox recently and isn't in a released version yet, so the Makefile would need to pin to a specific commit. Before I open the PR, should I also expand MD_FILES_TO_FORMAT to cover more of docs/, or just fix the validator config?

  3. added 4 commits that reference this issue on Aug 23, 2026
    0ce48df
    840ebcb
    17a9887
    cbbaa11
  4. added a commit that references this issue on Sep 3, 2026
    7e3b159
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    technical-bugIssues with the doc building tooling

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions