Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add internal link checker #34

Open
pedro-psb opened this issue Apr 10, 2024 · 0 comments
Open

Add internal link checker #34

pedro-psb opened this issue Apr 10, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@pedro-psb
Copy link
Member

pedro-psb commented Apr 10, 2024

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
@pedro-psb pedro-psb added the enhancement New feature or request label Jun 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant