Skip to content

Commit d4e44fd

Browse files
authored
docs: fix Gateway API link (#7364)
fix links Signed-off-by: zirain <zirain2009@gmail.com>
1 parent 689d266 commit d4e44fd

File tree

63 files changed

+358
-330
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

63 files changed

+358
-330
lines changed

.github/workflows/docs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ jobs:
3434
config_file: ".github/markdown_lint_config.json"
3535

3636
- name: Install linkinator
37-
run: npm install -g linkinator@6.0.4
37+
run: npm install -g linkinator@7.4.0
3838

3939
- name: Check links
4040
run: make docs docs-check-links

api/v1alpha1/envoygateway_types.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ type Gateway struct {
216216
// ControllerName defines the name of the Gateway API controller. If unspecified,
217217
// defaults to "gateway.envoyproxy.io/gatewayclass-controller". See the following
218218
// for additional details:
219-
// https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.GatewayClass
219+
// https://gateway-api.sigs.k8s.io/reference/1.4/spec/#gatewayclass
220220
//
221221
// +optional
222222
ControllerName string `json:"controllerName,omitempty"`

api/v1alpha1/envoyproxy_types.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ type EnvoyProxySpec struct {
151151
IPFamily *IPFamily `json:"ipFamily,omitempty"`
152152

153153
// PreserveRouteOrder determines if the order of matching for HTTPRoutes is determined by Gateway-API
154-
// specification (https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.HTTPRouteRule)
154+
// specification (https://gateway-api.sigs.k8s.io/reference/1.4/spec/#httprouterule)
155155
// or preserves the order defined by users in the HTTPRoute's HTTPRouteRule list.
156156
// Default: False
157157
//

charts/gateway-crds-helm/templates/generated/gateway.envoyproxy.io_envoyproxies.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -454,7 +454,7 @@ spec:
454454
preserveRouteOrder:
455455
description: |-
456456
PreserveRouteOrder determines if the order of matching for HTTPRoutes is determined by Gateway-API
457-
specification (https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.HTTPRouteRule)
457+
specification (https://gateway-api.sigs.k8s.io/reference/1.4/spec/#httprouterule)
458458
or preserves the order defined by users in the HTTPRoute's HTTPRouteRule list.
459459
Default: False
460460
type: boolean

charts/gateway-helm/crds/generated/gateway.envoyproxy.io_envoyproxies.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -453,7 +453,7 @@ spec:
453453
preserveRouteOrder:
454454
description: |-
455455
PreserveRouteOrder determines if the order of matching for HTTPRoutes is determined by Gateway-API
456-
specification (https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.HTTPRouteRule)
456+
specification (https://gateway-api.sigs.k8s.io/reference/1.4/spec/#httprouterule)
457457
or preserves the order defined by users in the HTTPRoute's HTTPRouteRule list.
458458
Default: False
459459
type: boolean

site/content/en/contributions/design/bootstrap.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -377,5 +377,5 @@ spec:
377377

378378
[Issue 31]: https://github.com/envoyproxy/gateway/issues/31
379379
[EnvoyProxy]: ../../latest/api/extension_types#envoyproxy
380-
[GatewayClass]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.GatewayClass
381-
[parametersRef]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.ParametersReference
380+
[GatewayClass]: https://gateway-api.sigs.k8s.io/reference/1.4/spec/#gatewayclass
381+
[parametersRef]: https://gateway-api.sigs.k8s.io/reference/1.4/spec/#parametersreference

site/content/en/contributions/design/config-api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ type Gateway struct {
8888
// defaults to "gateway.envoyproxy.io/gatewayclass-controller". See the following
8989
// for additional details:
9090
//
91-
// https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.GatewayClass
91+
// https://gateway-api.sigs.k8s.io/reference/1.4/spec/#gatewayclass
9292
//
9393
// +optional
9494
ControllerName string `json:"controllerName,omitempty"`
@@ -348,6 +348,6 @@ __Note:__ The NetworkPublishing API is currently undefined and is provided here
348348
[issue_51]: https://github.com/envoyproxy/gateway/issues/51
349349
[design_doc]: ../system-design/
350350
[gw_api]: https://gateway-api.sigs.k8s.io/
351-
[gc]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.GatewayClass
351+
[gc]: https://gateway-api.sigs.k8s.io/reference/1.4/spec/#gatewayclass
352352
[cr]: https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/
353353
[union]: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#unions

site/content/en/contributions/design/extending-envoy-gateway.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -324,20 +324,20 @@ whenever Envoy Gateway creates an instance of Envoy Proxy. An extension develope
324324
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.
325325

326326
[official goals]: https://github.com/envoyproxy/gateway/blob/main/GOALS.md#extensibility
327-
[ExtensionRef filters]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.LocalObjectReference
328-
[ExtensionRef]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.LocalObjectReference
329-
[ExtensionRefs]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.LocalObjectReference
330-
[backendRefs]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.BackendObjectReference
327+
[ExtensionRef filters]: https://gateway-api.sigs.k8s.io/reference/1.4/spec/#localobjectreference
328+
[ExtensionRef]: https://gateway-api.sigs.k8s.io/reference/1.4/spec/#localobjectreference
329+
[ExtensionRefs]: https://gateway-api.sigs.k8s.io/reference/1.4/spec/#localobjectreference
330+
[backendRefs]: https://gateway-api.sigs.k8s.io/reference/1.4/spec/#backendobjectreference
331331
[Gateway API Policy attachments]: https://gateway-api.sigs.k8s.io/references/policy-attachment/?h=policy
332332
[Policy Attachments]: https://gateway-api.sigs.k8s.io/references/policy-attachment/?h=policy
333333
[policyAttachments]: https://gateway-api.sigs.k8s.io/references/policy-attachment/?h=policy
334334
[Envoy]: https://www.envoyproxy.io/
335335
[Envoy specific configuration (xDS)]: https://www.envoyproxy.io/docs/envoy/v1.25.1/configuration/configuration
336-
[v1]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1
336+
[v1]: https://gateway-api.sigs.k8s.io/reference/1.4/spec/
337337
[rate limiting]: ./rate-limit
338338
[authentication]: ../../latest/tasks/security/jwt-authentication
339-
[HTTPRoute]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.HTTPRoute
340-
[GRPCRoute]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1alpha2.GRPCRoute
339+
[HTTPRoute]: https://gateway-api.sigs.k8s.io/reference/1.4/spec/#httproute
340+
[GRPCRoute]: https://gateway-api.sigs.k8s.io/reference/1.4/spec/#grpcroute
341341
[EnvoyGateway config]: ../../latest/api/extension_types#envoygateway
342342
[controller-runtime]: https://github.com/kubernetes-sigs/controller-runtime
343343
[Unstructured]: https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1/unstructured

site/content/en/contributions/design/rate-limit.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -429,12 +429,12 @@ attribute such as [IP subnet][] in the future that are not relevant in the [HTTP
429429
* 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.
430430

431431
[PolicyAttachment]: https://gateway-api.sigs.k8s.io/references/policy-attachment/
432-
[HTTPRoute]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.HTTPRoute
433-
[HTTPRouteRule]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.HTTPRouteRule
434-
[HTTPBackendRef]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.HTTPBackendRef
435-
[matches]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.HTTPRouteMatch
436-
[rule]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.HTTPRouteMatch
437-
[extensionRef]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.HTTPRouteFilterType
432+
[HTTPRoute]: https://gateway-api.sigs.k8s.io/reference/1.4/spec/#httproute
433+
[HTTPRouteRule]: https://gateway-api.sigs.k8s.io/reference/1.4/spec/#httprouteRule
434+
[HTTPBackendRef]: https://gateway-api.sigs.k8s.io/reference/1.4/spec/#httpbackendref
435+
[matches]: https://gateway-api.sigs.k8s.io/reference/1.4/spec/#httprouteMatch
436+
[rule]: https://gateway-api.sigs.k8s.io/reference/1.4/spec/#httprouteMatch
437+
[extensionRef]: https://gateway-api.sigs.k8s.io/reference/1.4/spec/#httproutefiltertype
438438
[IP subnet]: https://en.wikipedia.org/wiki/Subnetwork
439439
[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
440440
[descriptors]: https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/rate_limit_filter.html?highlight=descriptor#example-1

site/content/en/contributions/design/system-design.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ The draft for this document is [here][draft_design].
166166
[cluster]: https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/cluster/v3/cluster.proto#config-cluster-v3-cluster
167167
[draft_design]: https://docs.google.com/document/d/1riyTPPYuvNzIhBdrAX8dpfxTmcobWZDSYTTB5NeybuY/edit
168168
[cr]: https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/
169-
[be]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.BackendObjectReference
169+
[be]: https://gateway-api.sigs.k8s.io/reference/1.4/spec/#backendobjectreference
170170
[svc]: https://kubernetes.io/docs/concepts/services-networking/service/
171171
[wcd]: ../watching
172172
[Issue #37]: https://github.com/envoyproxy/gateway/issues/37

0 commit comments

Comments
 (0)