Skip to content

Add a link validator and fix broken links #4363

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.

Sign up for GitHub

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

Jump to bottom
Open
rikatz wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Add a link validator and fix broken links #4363

rikatz wants to merge 7 commits into from
+117 −78

Conversation

@rikatz
Copy link
Member

@rikatz rikatz commented Dec 17, 2025 •
edited
Loading

What type of PR is this?
/kind documentation

What this PR does / why we need it:

  • Add a new make target "verify-docs" to validate the docs links.
  • Add it to CI
  • Fixes 23 broken links and 46 broken anchors

Which issue(s) this PR fixes:
Fixes: #4231

Does this PR introduce a user-facing change?:

NONE

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/documentation Categorizes issue or PR as related to documentation. labels Dec 17, 2025
@k8s-ci-robot k8s-ci-robot added do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. kind/gep PRs related to Gateway Enhancement Proposal(GEP) size/M Denotes a PR that changes 30-99 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Dec 17, 2025
@rikatz rikatz force-pushed the broken-link-validation branch from 7f6132c to c05e96c Compare December 18, 2025 12:34
@rikatz
Copy link
Member Author

rikatz commented Dec 18, 2025

I will fix the broken anchors soon

@robscott robscott mentioned this pull request Dec 19, 2025
Open
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Dec 19, 2025
@rikatz rikatz mentioned this pull request Dec 22, 2025
Open
@rikatz rikatz force-pushed the broken-link-validation branch from e2b428c to 22a27d4 Compare December 22, 2025 19:24
LiorLieberman
LiorLieberman approved these changes Dec 22, 2025
View reviewed changes
Copy link
Member

@LiorLieberman LiorLieberman left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm, two nits
/hold

site-src/contributing/devguide.md

Example:

```golang
Copy link
Member

@LiorLieberman LiorLieberman Dec 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

whats that change for?

Copy link
Member Author

@rikatz rikatz Dec 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

because it was pointing to a dead code on Kubernetes API, and btw pointing to Github with the line of the code (`#L7444') is an invalid anchor and breaks. So it was better just to point how a dead API should look like

@youngnick
Copy link
Contributor

youngnick commented Dec 23, 2025

Thanks for this @rikatz, lgtm.

/approve

@k8s-ci-robot
Copy link
Contributor

k8s-ci-robot commented Dec 23, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: LiorLieberman, rikatz, youngnick

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@arkodg arkodg Awaiting requested review from arkodg

@howardjohn howardjohn Awaiting requested review from howardjohn

1 more reviewer

@LiorLieberman LiorLieberman LiorLieberman approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. kind/documentation Categorizes issue or PR as related to documentation. kind/gep PRs related to Gateway Enhancement Proposal(GEP) release-note-none Denotes a PR that doesn't merit a release note. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Analyze the usage of a broken link validation on pipelines

4 participants

@rikatz @youngnick @k8s-ci-robot @LiorLieberman