-
Notifications
You must be signed in to change notification settings - Fork 15
Open
Labels
enhancementNew feature or requestNew feature or request
Description
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-docsApproaches 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
Labels
enhancementNew feature or requestNew feature or request