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 dead link checker to CI #2110

Open
holly-cummins opened this issue Sep 4, 2024 · 0 comments
Open

Add dead link checker to CI #2110

holly-cummins opened this issue Sep 4, 2024 · 0 comments

Comments

@holly-cummins
Copy link
Contributor

holly-cummins commented Sep 4, 2024

We should not be making our users identify and report dead links for us (for example, most recently #1987 and #2093 and quarkusio/quarkus#42688 (comment)). Computers can do this job more effectively than people, and unlike people, they don't become disappointed in us when they find dead links.

We want to catch new dead links when they're introduced, and alert maintainers when existing links stop working. Getting that exact behaviour is non-trivial, but we can get close to it by failing the CI for problems with internal links, and raising a defect if external links stop working. It's possible that a PR would introduce a new external link that never worked at all, but it's more usual that links work when they're created, and then stop working.

The http://hub.quarkiverse.io and http://quarkus.io/extensions pages both use this model, so we should be able to copy their implementations.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant