Skip to content

docs: fix broken links #4217

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
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

docs: fix broken links #4217

wants to merge 5 commits into from
+27 −27

Conversation

@zirain
Copy link
Contributor

@zirain zirain commented Nov 3, 2025

What type of PR is this?

/kind documentation

What this PR does / why we need it:

Which issue(s) this PR fixes:

Fixes #

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. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Nov 3, 2025
@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Nov 3, 2025
@zirain zirain mentioned this pull request Nov 3, 2025
Open
@LiorLieberman
Copy link
Member

LiorLieberman commented Nov 3, 2025

/lgtm
/cc @rikatz

@k8s-ci-robot k8s-ci-robot requested a review from rikatz November 3, 2025 04:23
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 3, 2025
@LiorLieberman
Copy link
Member

LiorLieberman commented Nov 3, 2025

/assign @rikatz

rikatz
rikatz reviewed Nov 3, 2025
View reviewed changes
rikatz
rikatz reviewed Nov 3, 2025
View reviewed changes
rikatz
rikatz reviewed Nov 3, 2025
View reviewed changes
site-src/api-types/backendtlspolicy.md Outdated
[options]: ../references/spec/#gateway.networking.k8s.io/v1alpha3.GatewayTLSConfig
[targetRefs]: ../references/spec/#localpolicytargetreferencewithsectionname
[subjectAltNames]: ../references/spec/#subjectaltname
[options]: ../references/spec/#gatewaytlsconfig
Copy link
Member

@rikatz rikatz Nov 3, 2025

Choose a reason for hiding this comment

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

this link is broken

Copy link
Contributor Author

@zirain zirain Nov 3, 2025

Choose a reason for hiding this comment

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

this's a map, let's link to backendtlspolicyspec.

rikatz
rikatz reviewed Nov 3, 2025
View reviewed changes
rikatz
rikatz reviewed Nov 3, 2025
View reviewed changes
rikatz
rikatz suggested changes Nov 3, 2025
View reviewed changes
Copy link
Member

@rikatz rikatz left a comment

Choose a reason for hiding this comment

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

some links are broken, can you please double check?

for instance here is a preview of the changes: https://deploy-preview-4217--kubernetes-sigs-gateway-api.netlify.app/

@k8s-ci-robot
Copy link
Contributor

k8s-ci-robot commented Nov 3, 2025

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: zirain
Once this PR has been reviewed and has the lgtm label, please ask for approval from rikatz. For more information see the Code Review Process.

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

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 removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 3, 2025
@k8s-ci-robot
Copy link
Contributor

k8s-ci-robot commented Nov 3, 2025

New changes are detected. LGTM label has been removed.

@zirain
Copy link
Contributor Author

zirain commented Nov 3, 2025

some links are broken, can you please double check?

for instance here is a preview of the changes: https://deploy-preview-4217--kubernetes-sigs-gateway-api.netlify.app/

updated

@zirain zirain requested a review from rikatz November 5, 2025 00:06
rikatz
rikatz reviewed Nov 5, 2025
View reviewed changes
site-src/api-types/backendtlspolicy.md Outdated
[targetRefs]: ../references/spec/#gateway.networking.k8s.io/v1alpha2.PolicyTargetReference
[subjectAltNames]: ../references/spec/#gateway.networking.k8s.io/v1alpha3.BackendTLSPolicyValidation
[options]: ../references/spec/#gateway.networking.k8s.io/v1alpha3.GatewayTLSConfig
[targetRefs]: ../reference/spec/#localpolicytargetreferencewithsectionname
Copy link
Member

@rikatz rikatz Nov 5, 2025

Choose a reason for hiding this comment

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

This is still not working. On https://deploy-preview-4217--kubernetes-sigs-gateway-api.netlify.app/api-types/backendtlspolicy/ if you click on TargetRefs it will give you a 404.

Suggested change
[targetRefs]: ../reference/spec/#localpolicytargetreferencewithsectionname
[targetRefs]: ../reference/spec.md#localpolicytargetreferencewithsectionname

Copy link
Member

@rikatz rikatz Nov 5, 2025

Choose a reason for hiding this comment

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

btw it should be here: https://deploy-preview-4217--kubernetes-sigs-gateway-api.netlify.app/reference/spec/#localpolicytargetreferencewithsectionname

I suggest running a make live-docs on your local computer and testing all of the links :)

Copy link
Contributor Author

@zirain zirain Nov 5, 2025

Choose a reason for hiding this comment

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

Thanks for your patient, I double checked this page, it should be fine now.

we can add linkinator to help this in the future.

rikatz
rikatz reviewed Nov 5, 2025
View reviewed changes
site-src/api-types/backendtlspolicy.md Outdated
[subjectAltNames]: ../references/spec/#gateway.networking.k8s.io/v1alpha3.BackendTLSPolicyValidation
[options]: ../references/spec/#gateway.networking.k8s.io/v1alpha3.GatewayTLSConfig
[targetRefs]: ../reference/spec/#localpolicytargetreferencewithsectionname
[subjectAltNames]: ../reference/spec/#subjectaltname
Copy link
Member

@rikatz rikatz Nov 5, 2025

Choose a reason for hiding this comment

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

this has the same problem as above

rikatz
rikatz reviewed Nov 5, 2025
View reviewed changes
site-src/api-types/backendtlspolicy.md Outdated
[options]: ../references/spec/#gateway.networking.k8s.io/v1alpha3.GatewayTLSConfig
[targetRefs]: ../reference/spec/#localpolicytargetreferencewithsectionname
[subjectAltNames]: ../reference/spec/#subjectaltname
[options]: ../reference/spec/#backendtlspolicyspec
Copy link
Member

@rikatz rikatz Nov 5, 2025

Choose a reason for hiding this comment

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

same

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

Reviewers

@LiorLieberman LiorLieberman Awaiting requested review from LiorLieberman

@mikemorris mikemorris Awaiting requested review from mikemorris

1 more reviewer

@rikatz rikatz rikatz requested changes

Reviewers whose approvals may not affect merge requirements

Assignees

@rikatz rikatz

@LiorLieberman LiorLieberman

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. release-note-none Denotes a PR that doesn't merit a release note. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@zirain @LiorLieberman @k8s-ci-robot @rikatz