nasa / fprime

F´ - A flight software and embedded systems framework
https://fprime.jpl.nasa.gov
Apache License 2.0
9.95k stars 1.28k forks source link

Ignore all HTTP links in Markdown link check #2793

Closed thomas-bc closed 2 days ago

thomas-bc commented 2 days ago
Related Issue(s)
Has Unit Tests (y/n)
Documentation Included (y/n)

Change Description

I propose we ignore all HTTP(s?) links in the Markdown link checks. It has been causing some issues, most of the time the link is just unavailable at the time the check is ran, or some redirect/authentication/unknown issues.

The purpose for which we introduced this check was mostly for checking relative MD links within our docs, which it does well. If a web link is broken, most of the time the user can make sense of how to get it back. Worst case, we can change it when it gets discovered.

The tradeoff of development time vs. benefit is not clear, so I suggest we drop those checks.