[DOCS] Add lychee link checker with pre-commit
#1366
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Clean up and improve the docs. Update the Makefile. https://github.com/lycheeverse/lychee "Fast, async, stream-based link checker written in Rust. Finds broken URLs and mail addresses inside Markdown, HTML, reStructuredText, websites and more!"
|
After we fix the remaining broken links we can then choose going forwards to just check the links in modified files by running The full check is taking 3 minutes so far. |
jbampton
commented
Apr 25, 2024
jbampton
commented
Apr 25, 2024
| "http://localhost:.*", | ||
| "https://whimsy.apache.org/officers/acreq.*", | ||
| "https://whimsy.apache.org/roster/pmc/sedona.*", | ||
| "https://www.datasyslab.net/", |
There was a problem hiding this comment.
Hey @jiayuasu this datasyslab link is broken
sedona/docs/community/publication.md
Line 3 in 181ad31
There was a problem hiding this comment.
@jbampton Can you replace it with this one: https://datasystemslab.engineering.asu.edu/
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Clean up and improve the docs. Update the Makefile.
https://github.com/lycheeverse/lychee
"Fast, async, stream-based link checker written in Rust. Finds broken URLs and mail addresses inside Markdown, HTML, reStructuredText, websites and more!"
Did you read the Contributor Guide?
Is this PR related to a JIRA ticket?
[DOCS] my subject.What changes were proposed in this PR?
Updated our hooks with
pre-commit autoupdateAdded the lychee link checker.
fixes #1360
lycheeseems to be more advanced thanmarkdown-link-check.In future we can add pre-commit inside Docker to allow contributors to run the pre-commit tests with Docker.
Since link checker tests can sometimes make a lot of noise and fail, I have separated the link checker from the other pre-commit checks.
How was this patch tested?
Ran Makefile command:
make checklinksRan pre-commit ( no link checker):
make checkThis is my current output from running lychee locally
We have two broken links.
Did this PR include necessary documentation updates?