Skip to content

Add internal link checker #34

@pedro-psb

Description

@pedro-psb

Although link checking will not be strictly static (it may try to build the site), I'd like to put it under a general linting category of commands. For now, the only "linter" would be internal link checker (should we add external as well?)

# run all linting on all code
pulp-docs lint

# run link-check on all code
pulp-docs lint --linters link-check

# run link-check on pulp-docs only
pulp-docs lint --linters link-check --repos pulp-docs

Approaches Considered

  • Leverage mkdocs validation + tricks to select only links from a single repository
  • Find another link checker

Current plan (september 2025)

  • Add link-checker to pulp-docs cli #148 - Requirement: should be possible to run locally or on CI
  • Add a pulp-docs configuration for members - Plugins can opt-in to new features (docs/pulpdocs.yml)
  • Add an optional link-check job to docs CI - If link-checking in enabled for a member it'll be enforced

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions