weekly link check of the 3 main branches: main, development and development-split.
the weekly link check runs at 6 AM (UTC) on Friday, the day of the week where most of the dev team is usually not working.
link check on push for all 3 branches mentioned above
Notes
In all cases, we check for 404 errors on all the manual, and only display the errors as warnings. So the code exit with exit(0)
We could set the link checker to give errors and exit with exit(1) for 404. I start with warnings instead of errors to see how it goes. We can adjust in the future, and also query for more error types. We can discuss this if needed.
Once it's going well (and we cleaned all the current errors, see this PR), we can set errors instead of warnings and thus receive weekly report by email if a link isn't working anymore.
We set weekly checks and not only on push, since URLs outside of the manual can change (e.g. presearch docs changes a link, so we must adjust it on the manual).
Future Use Cases
Once we are satisfied with the link checker, we can implement it on all other mdbooks and threefold websites, as it can be used for any dynamic and static websites, that are online.
Link Checker for the TF Manual
As an answer to this issue, @scottyeager and I worked on a link checker.
How It Works
This PR proposes the following:
Notes
Future Use Cases
Once we are satisfied with the link checker, we can implement it on all other mdbooks and threefold websites, as it can be used for any dynamic and static websites, that are online.