Skip to content

Commit b5f7b53

Browse files
committed
docs: Add API specification links to user guides
Add links to relevant API specification sections in documentation guides to improve navigation between practical examples and detailed API documentation. This addresses issue #4347 by adding links to the following guides: - HTTP feature guides (CORS, timeouts, method matching, etc.) - gRPC and traffic splitting guides - TLS configuration guide - Getting started guide All links follow the established pattern used in existing guides and reference the correct v1 API types. Fixes #4347 Signed-off-by: YASHMAHAKAL <[email protected]>
1 parent e00265b commit b5f7b53

File tree

10 files changed

+16
-16
lines changed

10 files changed

+16
-16
lines changed

site-src/guides/getting-started/simple-gateway.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ This guide is a great place to start if you are new to Gateway API. It shows the
88
{% include 'standard/simple-gateway/gateway.yaml' %}
99
```
1010

11-
The Gateway represents the instantiation of a logical load balancer and the
12-
GatewayClass defines the load balancer template when users create a Gateway.
11+
The [Gateway](../../reference/spec.md#gateway.networking.k8s.io/v1.Gateway) represents the instantiation of a logical load balancer and the
12+
[GatewayClass](../../reference/spec.md#gateway.networking.k8s.io/v1.GatewayClass) defines the load balancer template when users create a Gateway.
1313
The example Gateway is templated from a hypothetical `example`
1414
GatewayClass, which is meant to be a placeholder and substituted by users. Here
1515
is a list of available
@@ -21,10 +21,10 @@ The Gateway listens for HTTP traffic on port 80. This particular GatewayClass
2121
automatically assigns an IP address which will be shown in the `Gateway.status`
2222
after it has been deployed.
2323

24-
Route resources specify the Gateways they want to attach to using `ParentRefs`. As long as
24+
Route resources specify the Gateways they want to attach to using [`ParentRefs`](../../reference/spec.md#gateway.networking.k8s.io/v1.ParentReference). As long as
2525
the Gateway allows this attachment (by default Routes from the same namespace are trusted),
2626
this will allow the Route to receive traffic from the parent Gateway.
27-
`BackendRefs` define the backends that traffic will be sent to. More complex
27+
[`BackendRefs`](../../reference/spec.md#gateway.networking.k8s.io/v1.HTTPBackendRef) define the backends that traffic will be sent to. More complex
2828
bi-directional matching and permissions are possible and explained in other guides.
2929

3030
The following HTTPRoute defines how traffic from the Gateway listener is routed

site-src/guides/grpc-routing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# gRPC routing
22

33
The [GRPCRoute resource](../api-types/grpcroute.md) allows you to match on gRPC traffic and
4-
direct it to Kubernetes backends. This guide shows how the GRPCRoute matches
4+
direct it to Kubernetes backends. This guide shows how the [GRPCRoute](../reference/spec.md#gateway.networking.k8s.io/v1.GRPCRoute) matches
55
traffic on host, header, and service, and method fields and forwards it to different
66
Kubernetes Services.
77

site-src/guides/http-cors.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Cross-Origin Resource Sharing (CORS). CORS is a security feature that allows
88
or denies web applications running at one domain to make requests for resources
99
from a different domain.
1010

11-
The `CORS` filter in an `HTTPRouteRule` can be used to specify the CORS policy.
11+
The [`CORS` filter](../reference/spec.md#gateway.networking.k8s.io/v1.HTTPCORSFilter) in an `HTTPRouteRule` can be used to specify the CORS policy.
1212

1313
## Allowing requests from a specific origin
1414

site-src/guides/http-header-modifier.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# HTTP Header Modifiers
22

33
[HTTPRoute resources](../api-types/httproute.md) can modify the headers of HTTP requests and the HTTP responses from clients.
4-
There are two types of [filters](../api-types/httproute.md#filters-optional) available to meet these requirements: `RequestHeaderModifier` and `ResponseHeaderModifier`.
4+
There are two types of [filters](../api-types/httproute.md#filters-optional) available to meet these requirements: [`RequestHeaderModifier`](../reference/spec.md#gateway.networking.k8s.io/v1.HTTPHeaderFilter) and [`ResponseHeaderModifier`](../reference/spec.md#gateway.networking.k8s.io/v1.HTTPHeaderFilter).
55

66
This guide shows how to use these features.
77

site-src/guides/http-method-matching.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
This feature is part of extended support. For more information on release channels, refer to our [versioning guide](../concepts/versioning.md).
55

66
The [HTTPRoute resource](../api-types/httproute.md) can be used to match
7-
requests based on the HTTP method. This guide shows how to use this
7+
requests based on the [HTTP method](../reference/spec.md#gateway.networking.k8s.io/v1.HTTPRouteMatch). This guide shows how to use this
88
functionality.
99

1010
## Matching requests based on the HTTP method

site-src/guides/http-query-param-matching.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
This feature is part of extended support. For more information on release channels, refer to our [versioning guide](../concepts/versioning.md).
55

66
The [HTTPRoute resource](../api-types/httproute.md) can be used to match
7-
requests based on query parameters. This guide shows how to use this
7+
requests based on [query parameters](../reference/spec.md#gateway.networking.k8s.io/v1.HTTPQueryParamMatch). This guide shows how to use this
88
functionality.
99

1010
## Matching requests based on a single query parameter

site-src/guides/http-request-mirroring.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
???+ info "Extended Support Feature: HTTPRouteRequestMirror"
44
This feature is part of extended support. For more information on release channels, refer to our [versioning guide](../concepts/versioning.md).
55

6-
The [HTTPRoute resource](../api-types/httproute.md) can be used to mirror
7-
requests to multiple backends. This is useful for testing new services with
6+
The [HTTPRoute resource](../api-types/httproute.md) can be used to [mirror
7+
requests](../reference/spec.md#gateway.networking.k8s.io/v1.HTTPRequestMirrorFilter) to multiple backends. This is useful for testing new services with
88
production traffic.
99

1010
Mirrored requests will only be sent to one single destination endpoint

site-src/guides/http-timeouts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
This feature is part of extended support. For more information on release channels, refer to our [versioning guide](../concepts/versioning.md).
55

66
The [HTTPRoute resource](../api-types/httproute.md) can be used to configure
7-
timeouts for HTTP requests. This is useful for preventing long-running requests
7+
[timeouts](../reference/spec.md#gateway.networking.k8s.io/v1.HTTPRouteTimeouts) for HTTP requests. This is useful for preventing long-running requests
88
from consuming resources and for providing a better user experience.
99

1010
The `timeouts` field in an `HTTPRouteRule` can be used to specify a request

site-src/guides/tls.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,11 @@ The use of `Terminate` on `TLSRoute` is available on `Extended` [Support Level].
5454

5555
## Downstream TLS
5656

57-
Downstream TLS settings are configured using listeners at the Gateway level.
57+
Downstream TLS settings are configured using [listeners](../reference/spec.md#gateway.networking.k8s.io/v1.Listener) at the Gateway level.
5858

5959
### Listeners and TLS
6060

61-
Listeners expose the TLS setting on a per domain or subdomain basis.
61+
Listeners expose the [TLS setting](../reference/spec.md#gateway.networking.k8s.io/v1.GatewayTLSConfig) on a per domain or subdomain basis.
6262
TLS settings of a listener are applied to all domains that satisfy the
6363
`hostname` criteria.
6464

@@ -116,7 +116,7 @@ would be invalid.
116116

117117
## Upstream TLS
118118

119-
Upstream TLS settings are configured using the `BackendTLSPolicy` attached to a
119+
Upstream TLS settings are configured using the [`BackendTLSPolicy`](../reference/spec.md#gateway.networking.k8s.io/v1.BackendTLSPolicy) attached to a
120120
`Service` via a target reference.
121121

122122
This resource can be used to describe the SNI the Gateway should use to connect to the

site-src/guides/traffic-splitting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# HTTP traffic splitting
22

33
The [HTTPRoute resource](../api-types/httproute.md) allows you to specify
4-
weights to shift traffic between different backends. This is useful for
4+
[weights](../reference/spec.md#gateway.networking.k8s.io/v1.HTTPBackendRef) to shift traffic between different backends. This is useful for
55
splitting traffic during rollouts, canarying changes, or for emergencies.
66
The HTTPRoute`spec.rules.backendRefs` accepts a list of backends that a route
77
rule will send traffic to. The relative weights of these backends define

0 commit comments

Comments
 (0)