jbampton opened a new pull request, #1366:
URL: https://github.com/apache/sedona/pull/1366

   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?
   
   - Yes, I have read the [Contributor 
Rules](https://sedona.apache.org/latest-snapshot/community/rule/) and 
[Contributor Development 
Guide](https://sedona.apache.org/latest-snapshot/community/develop/)
   
   ## Is this PR related to a JIRA ticket?
   
   - No, this is a documentation update. The PR name follows the format `[DOCS] 
my subject`.
   
   ## What changes were proposed in this PR?
   
   Updated our hooks with `pre-commit autoupdate`
   
   Added the lychee link checker.
   
   fixes #1360 
   
   `lychee` seems to be more advanced than `markdown-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 checklinks`
   
   Ran pre-commit ( no link checker):
   
   `make check`
   
   This is my current output from running lychee locally
   
   ![Screenshot from 2024-04-26 
03-50-43](https://github.com/apache/sedona/assets/418747/f2831ddf-a4b2-4120-8021-2828b8b8aed4)
   
   We have two broken links.
   
   ## Did this PR include necessary documentation updates?
   
   - No, this PR does not affect any public API so no need to change the 
documentation.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscr...@sedona.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org

Reply via email to