Skip to content

Commit

Permalink
fix(docs): incorrect quickstart links (#2146)
Browse files Browse the repository at this point in the history
Signed-off-by: bitliu <[email protected]>
  • Loading branch information
Xunzhuo authored Nov 1, 2023
1 parent 77bcb3c commit defed57
Show file tree
Hide file tree
Showing 54 changed files with 80 additions and 80 deletions.
6 changes: 3 additions & 3 deletions site/content/en/latest/user/cors.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This instantiated resource can be linked to a [Gateway][Gateway], [HTTPRoute][HT

## Prerequisites

Follow the steps from the [Quickstart](quickstart.md) guide to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart](../quickstart) guide to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

## Configuration
Expand Down Expand Up @@ -53,7 +53,7 @@ kubectl get securitypolicy/cors-example -o yaml

## Testing

Ensure the `GATEWAY_HOST` environment variable from the [Quickstart](quickstart.md) guide is set. If not, follow the
Ensure the `GATEWAY_HOST` environment variable from the [Quickstart](../quickstart) guide is set. If not, follow the
Quickstart instructions to set the variable.

```shell
Expand Down Expand Up @@ -103,7 +103,7 @@ its configuration. It won't deny any requests. The browsers are responsible for

## Clean-Up

Follow the steps from the [Quickstart](quickstart.md) guide to uninstall Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart](../quickstart) guide to uninstall Envoy Gateway and the example manifest.

Delete the SecurityPolicy:

Expand Down
2 changes: 1 addition & 1 deletion site/content/en/latest/user/customize-envoyproxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Service. To learn more about GatewayClass and ParametersRef, please refer to [Ga

## Installation

Follow the steps from the [Quickstart Guide](quickstart.md) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

## Add GatewayClass ParametersRef
Expand Down
2 changes: 1 addition & 1 deletion site/content/en/latest/user/envoy-patch-policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ not exposed by Envoy Gateway APIs today.

### Prerequisites

* Follow the steps from the [Quickstart](quickstart.md) guide to install Envoy Gateway and the example manifest.
* Follow the steps from the [Quickstart](../quickstart) guide to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

### Enable EnvoyPatchPolicy
Expand Down
2 changes: 1 addition & 1 deletion site/content/en/latest/user/gateway-api-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The project also provides example dashboard for visualising the metrics using Gr

## Prerequisites

Follow the steps from the [Quickstart Guide](quickstart.md) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

Run the following commands to install the metrics stack, with the Gateway API State Metrics configuration, on your kubernetes cluster:
Expand Down
2 changes: 1 addition & 1 deletion site/content/en/latest/user/grafana-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This guide shows you how to visualise the metrics exposed to prometheus using gr

## Prerequisites

Follow the steps from the [Quickstart Guide](quickstart.md) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

Follow the steps from the [Proxy Observability](proxy-observability.md#Metrics) to enable prometheus metrics.
Expand Down
2 changes: 1 addition & 1 deletion site/content/en/latest/user/http-request-headers.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ client.

## Prerequisites

Follow the steps from the [Quickstart Guide](quickstart.md) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

## Adding Request Headers
Expand Down
2 changes: 1 addition & 1 deletion site/content/en/latest/user/http-response-headers.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ upstream service.

## Prerequisites

Follow the steps from the [Quickstart Guide](quickstart.md) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

## Adding Response Headers
Expand Down
2 changes: 1 addition & 1 deletion site/content/en/latest/user/http-traffic-splitting.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ with status code `500` for all requests that would have been sent to that backen

## Installation

Follow the steps from the [Quickstart Guide](quickstart.md) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

## Single backendRef
Expand Down
2 changes: 1 addition & 1 deletion site/content/en/latest/user/http-urlrewrite.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ used on a Route rule. This MUST NOT be used on the same Route rule as a HTTPRequ

## Prerequisites

Follow the steps from the [Quickstart Guide](quickstart.md) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

## Rewrite URL Prefix Path
Expand Down
6 changes: 3 additions & 3 deletions site/content/en/latest/user/jwt-authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This instantiated resource can be linked to a [Gateway][Gateway], [HTTPRoute][HT

## Prerequisites

Follow the steps from the [Quickstart](quickstart.md) guide to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart](../quickstart) guide to install Envoy Gateway and the example manifest.
For GRPC - follow the steps from the [GRPC Routing](grpc-routing.md) example.
Before proceeding, you should be able to query the example backend using HTTP or GRPC.

Expand Down Expand Up @@ -71,7 +71,7 @@ kubectl get securitypolicy/jwt-example -o yaml

## Testing

Ensure the `GATEWAY_HOST` environment variable from the [Quickstart](quickstart.md) guide is set. If not, follow the
Ensure the `GATEWAY_HOST` environment variable from the [Quickstart](../quickstart) guide is set. If not, follow the
Quickstart instructions to set the variable.

```shell
Expand Down Expand Up @@ -150,7 +150,7 @@ You should see the below response

## Clean-Up

Follow the steps from the [Quickstart](quickstart.md) guide to uninstall Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart](../quickstart) guide to uninstall Envoy Gateway and the example manifest.

Delete the SecurityPolicy:

Expand Down
2 changes: 1 addition & 1 deletion site/content/en/latest/user/proxy-observability.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This guide show you how to config proxy observability, includes metrics, logs, a

## Prerequisites

Follow the steps from the [Quickstart Guide](quickstart.md) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

[FluentBit](https://fluentbit.io/) is used to collect logs from the EnvoyProxy instances and forward them to Loki. Install FluentBit:
Expand Down
2 changes: 1 addition & 1 deletion site/content/en/latest/user/rate-limit.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ can be linked to a [Gateway][], [HTTPRoute][] or [GRPCRoute][] resource.

### Install Envoy Gateway

* Follow the steps from the [Quickstart Guide](quickstart.md) to install Envoy Gateway and the HTTPRoute example manifest.
* Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway and the HTTPRoute example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

### Install Redis
Expand Down
8 changes: 4 additions & 4 deletions site/content/en/latest/user/secure-gateways.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ testing and demonstration purposes only.

## Installation

Follow the steps from the [Quickstart Guide](quickstart.md) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

## TLS Certificates
Expand Down Expand Up @@ -242,7 +242,7 @@ Lastly, test connectivity using the above [Testing section](#testing).

## Clean-Up

Follow the steps from the [Quickstart Guide](quickstart.md) to uninstall Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../quickstart) to uninstall Envoy Gateway and the example manifest.

Delete the Secrets:

Expand All @@ -257,7 +257,7 @@ This section gives a walkthrough to generate RSA and ECDSA derived certificates

## Prerequisites

Follow the steps from the [Quickstart Guide](quickstart.md) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

Follow the steps in the [TLS Certificates](secure-gateways.md#tls-certificates) section in the guide to generate self-signed RSA derived Server certificate and private key, and configure those in the Gateway listener configuration to terminate HTTPS traffic.
Expand Down Expand Up @@ -369,7 +369,7 @@ This sections gives a walkthrough to generate multiple certificates correspondin
## Prerequisites
Follow the steps from the [Quickstart Guide](quickstart.md) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.
Follow the steps in the [TLS Certificates](secure-gateways.md#tls-certificates) section in the guide to generate self-signed RSA derived Server certificate and private key, and configure those in the Gateway listener configuration to terminate HTTPS traffic.
Expand Down
2 changes: 1 addition & 1 deletion site/content/en/latest/user/tls-cert-manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Changing to the Let's Encrypt production environment is straight-forward after t

## Installation

Follow the steps from the [Quickstart Guide](quickstart.md) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

## Deploying cert-manager
Expand Down
4 changes: 2 additions & 2 deletions site/content/en/latest/user/tls-passthrough.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ to terminate the TLS connection, while the Gateway routes the requests to the ap

## Installation

Follow the steps from the [Quickstart Guide](quickstart.md) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

## TLS Certificates
Expand Down Expand Up @@ -106,7 +106,7 @@ curl -v -HHost:passthrough.example.com --resolve "passthrough.example.com:6443:$

## Clean-Up

Follow the steps from the [Quickstart Guide](quickstart.md) to uninstall Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../quickstart) to uninstall Envoy Gateway and the example manifest.

Delete the Secret:

Expand Down
2 changes: 1 addition & 1 deletion site/content/en/latest/user/tls-termination.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This guide will walk through the steps required to configure TLS Terminate mode

## Installation

Follow the steps from the [Quickstart Guide](quickstart.md) to install Envoy Gateway.
Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway.

## TLS Certificates
Generate the certificates and keys used by the Gateway to terminate client TLS connections.
Expand Down
2 changes: 1 addition & 1 deletion site/content/en/latest/user/udp-routing.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ _udp.foo.bar.com. 0 IN SRV 0 0 42376 .
## Clean-Up
Follow the steps from the [Quickstart Guide](quickstart.md) to uninstall Envoy Gateway.
Follow the steps from the [Quickstart Guide](../quickstart) to uninstall Envoy Gateway.
Delete the CoreDNS example manifest and the UDPRoute:
Expand Down
2 changes: 1 addition & 1 deletion site/content/en/v0.2.0/user/http-request-headers.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ client.

## Prerequisites

Follow the steps from the [Quickstart Guide](quickstart.md) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

## Adding Request Headers
Expand Down
2 changes: 1 addition & 1 deletion site/content/en/v0.2.0/user/http-traffic-splitting.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ with status code `500` for all requests that would have been sent to that backen

## Installation

Follow the steps from the [Quickstart Guide](quickstart.md) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

## Single backendRef
Expand Down
4 changes: 2 additions & 2 deletions site/content/en/v0.2.0/user/secure-gateways.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ testing and demonstration purposes only.

## Installation

Follow the steps from the [Quickstart Guide](quickstart.md) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

## TLS Certificates
Expand Down Expand Up @@ -242,7 +242,7 @@ Lastly, test connectivity using the above [Testing section](#testing).

## Clean-Up

Follow the steps from the [Quickstart Guide](quickstart.md) to uninstall Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../quickstart) to uninstall Envoy Gateway and the example manifest.

Delete the Secrets:

Expand Down
4 changes: 2 additions & 2 deletions site/content/en/v0.2.0/user/tls-passthrough.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ to terminate the TLS connection, while the Gateway routes the requests to the ap

## Installation

Follow the steps from the [Quickstart Guide](quickstart.md) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

## TLS Certificates
Expand Down Expand Up @@ -106,7 +106,7 @@ curl -v -HHost:passthrough.example.com --resolve "passthrough.example.com:6443:$

## Clean-Up

Follow the steps from the [Quickstart Guide](quickstart.md) to uninstall Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../quickstart) to uninstall Envoy Gateway and the example manifest.

Delete the Secret:

Expand Down
6 changes: 3 additions & 3 deletions site/content/en/v0.3.0/user/authn.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ supports validating a JWT from an HTTP header, e.g. `Authorization: Bearer <toke

## Installation

Follow the steps from the [Quickstart](quickstart.md) guide to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart](../quickstart) guide to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

## Configuration
Expand Down Expand Up @@ -39,7 +39,7 @@ kubectl get authenticationfilter/jwt-example -o yaml

## Testing

Ensure the `GATEWAY_HOST` environment variable from the [Quickstart](quickstart.md) guide is set. If not, follow the
Ensure the `GATEWAY_HOST` environment variable from the [Quickstart](../quickstart) guide is set. If not, follow the
Quickstart instructions to set the variable.

```shell
Expand Down Expand Up @@ -79,7 +79,7 @@ curl -sS -o /dev/null -H "Host: www.example.com" -w "%{http_code}\n" http://$GAT

## Clean-Up

Follow the steps from the [Quickstart](quickstart.md) guide to uninstall Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart](../quickstart) guide to uninstall Envoy Gateway and the example manifest.

Delete the AuthenticationFilter:

Expand Down
2 changes: 1 addition & 1 deletion site/content/en/v0.3.0/user/http-request-headers.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ client.

## Prerequisites

Follow the steps from the [Quickstart Guide](quickstart.md) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

## Adding Request Headers
Expand Down
2 changes: 1 addition & 1 deletion site/content/en/v0.3.0/user/http-response-headers.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ upstream service.

## Prerequisites

Follow the steps from the [Quickstart Guide](quickstart.md) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

## Adding Response Headers
Expand Down
2 changes: 1 addition & 1 deletion site/content/en/v0.3.0/user/http-traffic-splitting.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ with status code `500` for all requests that would have been sent to that backen

## Installation

Follow the steps from the [Quickstart Guide](quickstart.md) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

## Single backendRef
Expand Down
2 changes: 1 addition & 1 deletion site/content/en/v0.3.0/user/http-urlrewrite.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ used on a Route rule. This MUST NOT be used on the same Route rule as a HTTPRequ

## Prerequisites

Follow the steps from the [Quickstart Guide](quickstart.md) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

## Rewrite URL Prefix Path
Expand Down
2 changes: 1 addition & 1 deletion site/content/en/v0.3.0/user/rate-limit.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ can be linked to a [HTTPRoute][] resource using an [ExtensionRef][] filter.

### Install Envoy Gateway

* Follow the steps from the [Quickstart Guide](quickstart.md) to install Envoy Gateway and the example manifest.
* Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

### Install Redis
Expand Down
4 changes: 2 additions & 2 deletions site/content/en/v0.3.0/user/secure-gateways.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ testing and demonstration purposes only.

## Installation

Follow the steps from the [Quickstart Guide](quickstart.md) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

## TLS Certificates
Expand Down Expand Up @@ -242,7 +242,7 @@ Lastly, test connectivity using the above [Testing section](#testing).

## Clean-Up

Follow the steps from the [Quickstart Guide](quickstart.md) to uninstall Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../quickstart) to uninstall Envoy Gateway and the example manifest.

Delete the Secrets:

Expand Down
4 changes: 2 additions & 2 deletions site/content/en/v0.3.0/user/tls-passthrough.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ to terminate the TLS connection, while the Gateway routes the requests to the ap

## Installation

Follow the steps from the [Quickstart Guide](quickstart.md) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

## TLS Certificates
Expand Down Expand Up @@ -106,7 +106,7 @@ curl -v -HHost:passthrough.example.com --resolve "passthrough.example.com:6443:$

## Clean-Up

Follow the steps from the [Quickstart Guide](quickstart.md) to uninstall Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../quickstart) to uninstall Envoy Gateway and the example manifest.

Delete the Secret:

Expand Down
2 changes: 1 addition & 1 deletion site/content/en/v0.3.0/user/udp-routing.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ _udp.foo.bar.com. 0 IN SRV 0 0 42376 .
## Clean-Up
Follow the steps from the [Quickstart Guide](quickstart.md) to uninstall Envoy Gateway.
Follow the steps from the [Quickstart Guide](../quickstart) to uninstall Envoy Gateway.
Delete the CoreDNS example manifest and the UDPRoute:
Expand Down
Loading

0 comments on commit defed57

Please sign in to comment.