Skip to content

docs: fix Gateway API link #7364

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 1 commit into from
Oct 30, 2025
Merged

docs: fix Gateway API link #7364

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion .github/workflows/docs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ jobs:
config_file: ".github/markdown_lint_config.json"

- name: Install linkinator
run: npm install -g linkinator@6.0.4
run: npm install -g linkinator@7.4.0

- name: Check links
run: make docs docs-check-links
Expand Down
2 changes: 1 addition & 1 deletion api/v1alpha1/envoygateway_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@ type Gateway struct {
// ControllerName defines the name of the Gateway API controller. If unspecified,
// defaults to "gateway.envoyproxy.io/gatewayclass-controller". See the following
// for additional details:
// https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.GatewayClass
// https://gateway-api.sigs.k8s.io/reference/1.4/spec/#gatewayclass
//
// +optional
ControllerName string `json:"controllerName,omitempty"`
Expand Down
2 changes: 1 addition & 1 deletion api/v1alpha1/envoyproxy_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ type EnvoyProxySpec struct {
IPFamily *IPFamily `json:"ipFamily,omitempty"`

// PreserveRouteOrder determines if the order of matching for HTTPRoutes is determined by Gateway-API
// specification (https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.HTTPRouteRule)
// specification (https://gateway-api.sigs.k8s.io/reference/1.4/spec/#httprouterule)
// or preserves the order defined by users in the HTTPRoute's HTTPRouteRule list.
// Default: False
//
Expand Down
2 changes: 1 addition & 1 deletion charts/gateway-crds-helm/templates/generated/gateway.envoyproxy.io_envoyproxies.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -454,7 +454,7 @@ spec:
preserveRouteOrder:
description: |-
PreserveRouteOrder determines if the order of matching for HTTPRoutes is determined by Gateway-API
specification (https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.HTTPRouteRule)
specification (https://gateway-api.sigs.k8s.io/reference/1.4/spec/#httprouterule)
or preserves the order defined by users in the HTTPRoute's HTTPRouteRule list.
Default: False
type: boolean
Expand Down
2 changes: 1 addition & 1 deletion charts/gateway-helm/crds/generated/gateway.envoyproxy.io_envoyproxies.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -453,7 +453,7 @@ spec:
preserveRouteOrder:
description: |-
PreserveRouteOrder determines if the order of matching for HTTPRoutes is determined by Gateway-API
specification (https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.HTTPRouteRule)
specification (https://gateway-api.sigs.k8s.io/reference/1.4/spec/#httprouterule)
or preserves the order defined by users in the HTTPRoute's HTTPRouteRule list.
Default: False
type: boolean
Expand Down
4 changes: 2 additions & 2 deletions site/content/en/contributions/design/bootstrap.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -377,5 +377,5 @@ spec:

[Issue 31]: https://github.com/envoyproxy/gateway/issues/31
[EnvoyProxy]: ../../latest/api/extension_types#envoyproxy
[GatewayClass]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.GatewayClass
[parametersRef]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.ParametersReference
[GatewayClass]: https://gateway-api.sigs.k8s.io/reference/1.4/spec/#gatewayclass
[parametersRef]: https://gateway-api.sigs.k8s.io/reference/1.4/spec/#parametersreference
4 changes: 2 additions & 2 deletions site/content/en/contributions/design/config-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ type Gateway struct {
// defaults to "gateway.envoyproxy.io/gatewayclass-controller". See the following
// for additional details:
//
// https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.GatewayClass
// https://gateway-api.sigs.k8s.io/reference/1.4/spec/#gatewayclass
//
// +optional
ControllerName string `json:"controllerName,omitempty"`
Expand Down Expand Up @@ -348,6 +348,6 @@ __Note:__ The NetworkPublishing API is currently undefined and is provided here
[issue_51]: https://github.com/envoyproxy/gateway/issues/51
[design_doc]: ../system-design/
[gw_api]: https://gateway-api.sigs.k8s.io/
[gc]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.GatewayClass
[gc]: https://gateway-api.sigs.k8s.io/reference/1.4/spec/#gatewayclass
[cr]: https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/
[union]: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#unions
14 changes: 7 additions & 7 deletions site/content/en/contributions/design/extending-envoy-gateway.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -324,20 +324,20 @@ whenever Envoy Gateway creates an instance of Envoy Proxy. An extension develope
Extending Envoy Gateway by using an external extension server which makes use of hook points in Envoy Gateway does comes with a few trade-offs. One known trade-off is the impact of the time that it takes for the hook calls to be executed. Since an extension would make use of hook points in Envoy Gateway that use gRPC for communication, the time it takes to perform these requests could become a concern for some extension developers. One way to minimize the request time of the hook calls is to load the extension server as a sidecar to Envoy Gateway using the Unix Local Domain transport to minimize the impact of networking on the hook calls.

[official goals]: https://github.com/envoyproxy/gateway/blob/main/GOALS.md#extensibility
[ExtensionRef filters]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.LocalObjectReference
[ExtensionRef]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.LocalObjectReference
[ExtensionRefs]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.LocalObjectReference
[backendRefs]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.BackendObjectReference
[ExtensionRef filters]: https://gateway-api.sigs.k8s.io/reference/1.4/spec/#localobjectreference
[ExtensionRef]: https://gateway-api.sigs.k8s.io/reference/1.4/spec/#localobjectreference
[ExtensionRefs]: https://gateway-api.sigs.k8s.io/reference/1.4/spec/#localobjectreference
[backendRefs]: https://gateway-api.sigs.k8s.io/reference/1.4/spec/#backendobjectreference
[Gateway API Policy attachments]: https://gateway-api.sigs.k8s.io/references/policy-attachment/?h=policy
[Policy Attachments]: https://gateway-api.sigs.k8s.io/references/policy-attachment/?h=policy
[policyAttachments]: https://gateway-api.sigs.k8s.io/references/policy-attachment/?h=policy
[Envoy]: https://www.envoyproxy.io/
[Envoy specific configuration (xDS)]: https://www.envoyproxy.io/docs/envoy/v1.25.1/configuration/configuration
[v1]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1
[v1]: https://gateway-api.sigs.k8s.io/reference/1.4/spec/
[rate limiting]: ./rate-limit
[authentication]: ../../latest/tasks/security/jwt-authentication
[HTTPRoute]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.HTTPRoute
[GRPCRoute]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1alpha2.GRPCRoute
[HTTPRoute]: https://gateway-api.sigs.k8s.io/reference/1.4/spec/#httproute
[GRPCRoute]: https://gateway-api.sigs.k8s.io/reference/1.4/spec/#grpcroute
[EnvoyGateway config]: ../../latest/api/extension_types#envoygateway
[controller-runtime]: https://github.com/kubernetes-sigs/controller-runtime
[Unstructured]: https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1/unstructured
Expand Down
12 changes: 6 additions & 6 deletions site/content/en/contributions/design/rate-limit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -429,12 +429,12 @@ attribute such as [IP subnet][] in the future that are not relevant in the [HTTP
* A Status field within the RateLimitFilter API will be added to reflect whether the specific configuration was programmed correctly in these multiple locations or not.

[PolicyAttachment]: https://gateway-api.sigs.k8s.io/references/policy-attachment/
Copy link
Contributor

@jukie jukie Oct 29, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Looks like references should be updated to reference. There's a redirect in place but that's what is causing issues.

Copy link
Contributor

@jukie jukie Oct 29, 2025

Choose a reason for hiding this comment

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

Looks like I was wrong here and it's more tedious. A few links on the https://gateway-api.sigs.k8s.io site are also breaking in the same way.

[HTTPRoute]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.HTTPRoute
[HTTPRouteRule]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.HTTPRouteRule
[HTTPBackendRef]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.HTTPBackendRef
[matches]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.HTTPRouteMatch
[rule]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.HTTPRouteMatch
[extensionRef]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.HTTPRouteFilterType
[HTTPRoute]: https://gateway-api.sigs.k8s.io/reference/1.4/spec/#httproute
[HTTPRouteRule]: https://gateway-api.sigs.k8s.io/reference/1.4/spec/#httprouteRule
[HTTPBackendRef]: https://gateway-api.sigs.k8s.io/reference/1.4/spec/#httpbackendref
[matches]: https://gateway-api.sigs.k8s.io/reference/1.4/spec/#httprouteMatch
[rule]: https://gateway-api.sigs.k8s.io/reference/1.4/spec/#httprouteMatch
[extensionRef]: https://gateway-api.sigs.k8s.io/reference/1.4/spec/#httproutefiltertype
[IP subnet]: https://en.wikipedia.org/wiki/Subnetwork
[Actions]: https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/route/v3/route_components.proto#envoy-v3-api-msg-config-route-v3-ratelimit-action
[descriptors]: https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/rate_limit_filter.html?highlight=descriptor#example-1
Expand Down
2 changes: 1 addition & 1 deletion site/content/en/contributions/design/system-design.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ The draft for this document is [here][draft_design].
[cluster]: https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/cluster/v3/cluster.proto#config-cluster-v3-cluster
[draft_design]: https://docs.google.com/document/d/1riyTPPYuvNzIhBdrAX8dpfxTmcobWZDSYTTB5NeybuY/edit
[cr]: https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/
[be]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.BackendObjectReference
[be]: https://gateway-api.sigs.k8s.io/reference/1.4/spec/#backendobjectreference
[svc]: https://kubernetes.io/docs/concepts/services-networking/service/
[wcd]: ../watching
[Issue #37]: https://github.com/envoyproxy/gateway/issues/37
Expand Down
Loading
Loading