ci: add docs link checker and mkdocs --strict - #2488
Open
aryasoni98 wants to merge 1 commit into
Open
Conversation
aryasoni98
requested review from
abaguas,
donovanmuller,
elohmrow,
jkremser,
k0da,
kuritka and
ytsarev
as code owners
August 4, 2026 12:01
✅ Deploy Preview for k8gb-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Add lychee-based CI (plus local make targets) so broken documentation links fail PRs, enable mkdocs build --strict, and fix the baseline broken URLs/samples needed for a green check. Fixes k8gb-io#2457 Signed-off-by: Arya Soni <aryasoni98@gmail.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Add lychee-based CI (plus local make targets) so broken documentation links fail PRs, enable mkdocs build --strict, and fix the baseline broken URLs/samples needed for a green check.
Fixes #2457
..
HOW TO RUN CI
---By default, all the checks will be run automatically. Furthermore, when changing website-related stuff, the preview will be generated by the netlify bot.
Heavy tests
Add the
heavy-testslabel on this PR if you want full-blown tests that include more than 2-cluster scenarios.Debug tests
If the test suite is failing for you, you may want to try triggering
Re-run all jobs(top right) with debug logging enabled. It will also make the print debug action more verbose.