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 link checker to ci #3332

Closed
6543 opened this issue Feb 5, 2024 · 4 comments · Fixed by #3371
Closed

add link checker to ci #3332

6543 opened this issue Feb 5, 2024 · 4 comments · Fixed by #3371
Labels
build CI pipeline related documentation docu & docs

Comments

@6543
Copy link
Member

6543 commented Feb 5, 2024

add a link checker for the docs into our pipelines.

https://lychee.cli.rs/ should be a good way to go.

this should run as a docs linter ... only for files changed and block
and weekly check the whole docs ... but do not block

@6543 6543 added documentation docu & docs build CI pipeline related labels Feb 5, 2024
@6543
Copy link
Member Author

6543 commented Feb 5, 2024

quick run:
image

so yes we need it!

@pat-s
Copy link
Contributor

pat-s commented Feb 5, 2024

lychee is great. Using it in some projects, fast and reliable.

@anbraten
Copy link
Member

anbraten commented Feb 6, 2024

Wasn't this error caught by: https://docusaurus.io/docs/api/docusaurus-config#onBrokenLinks

@6543
Copy link
Member Author

6543 commented Feb 6, 2024

Well docusaurus can at most check internal links, we should check all

6543 pushed a commit that referenced this issue Feb 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build CI pipeline related documentation docu & docs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants