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

Merged
merged 5 commits into from
Nov 6, 2025
+27 −27
Merged

docs: fix broken links #4217

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0678535
docs: fix broken links
zirain Nov 3, 2025
1cd5560
fix
zirain Nov 3, 2025
0a6b3e9
address review comment
zirain Nov 3, 2025
92b5b19
fix
zirain Nov 3, 2025
4eb2e46
fix
zirain Nov 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions site-src/api-types/backendtlspolicy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,12 +164,12 @@ Status defines the observed state of the BackendTLSPolicy and is not user-config
way you do for other Gateway API objects to verify correct operation. Note that the status in BackendTLSPolicy
uses `PolicyAncestorStatus` to allow you to know which parentReference set that particular status.

[backendtlspolicy]: ../reference/spec.md#gateway.networking.k8s.io/v1alpha3.BackendTLSPolicy
[validation]: ../reference/spec.md#gateway.networking.k8s.io/v1alpha3.BackendTLSPolicy.Validation
[caCertificateRefs]: ../reference/spec.md#gateway.networking.k8s.io/v1alpha3.BackendTLSPolicyValidation.CACertificateRefs
[wellKnownCACertificates]: ../reference/spec.md#gateway.networking.k8s.io/v1alpha3.BackendTLSPolicyValidation.WellKnownCACertificates
[hostname]: ../reference/spec.md#gateway.networking.k8s.io/v1.PreciseHostname
[backendtlspolicy]: ../reference/spec.md#backendtlspolicy
[validation]: ../reference/spec.md#backendtlspolicyvalidation
[caCertificateRefs]: ../reference/spec.md#localobjectreference
[wellKnownCACertificates]: ../reference/spec.md#localobjectreference
[hostname]: ../reference/spec.md#precisehostname
[rfc-3986]: https://tools.ietf.org/html/rfc3986
[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.

Copy link
Member

@rikatz rikatz Nov 6, 2025

Choose a reason for hiding this comment

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

no worries, I appreciate your effort on fixing it!

There is some ongoing effort to do this as a python hook: #3999

It is still probably too soon to try it, but I saw the authors of mkdocs material (which we use) are moving to a new approach as well: https://zensical.org/

Anyway, we can probably use linkinator as a github action (https://github.com/JustinBeckwith/linkinator#github-actions), it would be great if they provided also a docker image so we could add as some part of "make verify" here :) (I am scared of vendoring half of the internet for npx stuff!)

If you want to give it a try, and let us know on some issue later how your experiments with it or even something like https://github.com/lycheeverse/lychee would be great!

Copy link
Contributor Author

@zirain zirain Nov 7, 2025

Choose a reason for hiding this comment

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

I tried it locally, but it has almost over 1,000+ broken links. I haven't had enough bandwidth to fix it recently

Copy link
Member

@rikatz rikatz Nov 7, 2025

Choose a reason for hiding this comment

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

no worries, we can do it split on multiple efforts/parts! thanks

[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

[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

2 changes: 1 addition & 1 deletion site-src/api-types/gatewayclass.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,5 +141,5 @@ example.net/gateway/v2.1 // Use version 2.1
example.net/gateway // Use the default version
```

[gatewayclass]: ../reference/spec.md#gateway.networking.k8s.io/v1.GatewayClass
[gatewayclass]: ../reference/spec.md#gatewayclass
[ingress-class-api]: https://kubernetes.io/docs/concepts/services-networking/ingress/#ingress-class
16 changes: 8 additions & 8 deletions site-src/api-types/grpcroute.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,12 +272,12 @@ Multiple GRPCRoutes can be attached to a single Gateway resource. Importantly,
only one Route rule may match each request. For more information on how conflict
resolution applies to merging, refer to the [API specification][grpcrouterule].

[grpcroute]: ../reference/spec.md#gateway.networking.k8s.io/v1.GRPCRoute
[grpcrouterule]: ../reference/spec.md#gateway.networking.k8s.io/v1.GRPCRouteRule
[hostname]: ../reference/spec.md#gateway.networking.k8s.io/v1.Hostname
[grpcroute]: ../reference/spec.md#grpcroute
[grpcrouterule]: ../reference/spec.md#grpcrouterule
[hostname]: ../reference/spec.md#hostname
[rfc-3986]: https://tools.ietf.org/html/rfc3986
[matches]: ../reference/spec.md#gateway.networking.k8s.io/v1.GRPCRouteMatch
[filters]: ../reference/spec.md#gateway.networking.k8s.io/v1.GRPCRouteFilter
[backendRef]: ../reference/spec.md#gateway.networking.k8s.io/v1.GRPCBackendRef
[parentRef]: ../reference/spec.md#gateway.networking.k8s.io/v1.ParentRef
[name]: ../reference/spec.md#gateway.networking.k8s.io/v1.SectionName
[matches]: ../reference/spec.md#grpcroutematch
[filters]: ../reference/spec.md#grpcroutefilter
[backendRef]: ../reference/spec.md#grpcbackendref
[parentRef]: ../reference/spec.md#parentreference
[name]: ../reference/spec.md#sectionname
18 changes: 9 additions & 9 deletions site-src/api-types/httproute.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -336,14 +336,14 @@ only one Route rule may match each request. For more information on how conflict
resolution applies to merging, refer to the [API specification][httprouterule].


[httproute]: ../reference/spec.md#gateway.networking.k8s.io/v1.HTTPRoute
[httprouterule]: ../reference/spec.md#gateway.networking.k8s.io/v1.HTTPRouteRule
[hostname]: ../reference/spec.md#gateway.networking.k8s.io/v1.Hostname
[httproute]: ../reference/spec.md#httproute
[httprouterule]: ../reference/spec.md#httprouterule
[hostname]: ../reference/spec.md#hostname
[rfc-3986]: https://tools.ietf.org/html/rfc3986
[matches]: ../reference/spec.md#gateway.networking.k8s.io/v1.HTTPRouteMatch
[filters]: ../reference/spec.md#gateway.networking.k8s.io/v1.HTTPRouteFilter
[backendRef]: ../reference/spec.md#gateway.networking.k8s.io/v1.HTTPBackendRef
[parentRef]: ../reference/spec.md#gateway.networking.k8s.io/v1.ParentRef
[timeouts]: ../reference/spec.md#gateway.networking.k8s.io/v1.HTTPRouteTimeouts
[matches]: ../reference/spec.md#httproutematch
[filters]: ../reference/spec.md#httproutefilter
[backendRef]: ../reference/spec.md#httpbackendref
[parentRef]: ../reference/spec.md#parentreference
[timeouts]: ../reference/spec.md#httproutetimeouts
[appProtocol]: https://kubernetes.io/docs/concepts/services-networking/service/#application-protocol
[sectionName]: ../reference/spec.md#gateway.networking.k8s.io/v1.SectionName
[sectionName]: ../reference/spec.md#sectionname
2 changes: 1 addition & 1 deletion site-src/api-types/referencegrant.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ While the API is simplistic in nature, it comes with a few notable decisions:
other. This makes it impossible for them to conflict with each other.

Please see the [API
Specification](../reference/spec.md#gateway.networking.k8s.io/v1alpha2.ReferenceGrant)
Specification](../reference/spec.md#referencegrant)
for more details on how specific ReferenceGrant fields are interpreted.

## Implementation Guidelines
Expand Down