From defed574484e2708933d5f911b8bfc35e7ac8ee2 Mon Sep 17 00:00:00 2001 From: Xunzhuo Date: Wed, 1 Nov 2023 15:59:59 +0800 Subject: [PATCH] fix(docs): incorrect quickstart links (#2146) Signed-off-by: bitliu --- site/content/en/latest/user/cors.md | 6 +++--- site/content/en/latest/user/customize-envoyproxy.md | 2 +- site/content/en/latest/user/envoy-patch-policy.md | 2 +- site/content/en/latest/user/gateway-api-metrics.md | 2 +- site/content/en/latest/user/grafana-integration.md | 2 +- site/content/en/latest/user/http-request-headers.md | 2 +- site/content/en/latest/user/http-response-headers.md | 2 +- site/content/en/latest/user/http-traffic-splitting.md | 2 +- site/content/en/latest/user/http-urlrewrite.md | 2 +- site/content/en/latest/user/jwt-authentication.md | 6 +++--- site/content/en/latest/user/proxy-observability.md | 2 +- site/content/en/latest/user/rate-limit.md | 2 +- site/content/en/latest/user/secure-gateways.md | 8 ++++---- site/content/en/latest/user/tls-cert-manager.md | 2 +- site/content/en/latest/user/tls-passthrough.md | 4 ++-- site/content/en/latest/user/tls-termination.md | 2 +- site/content/en/latest/user/udp-routing.md | 2 +- site/content/en/v0.2.0/user/http-request-headers.md | 2 +- site/content/en/v0.2.0/user/http-traffic-splitting.md | 2 +- site/content/en/v0.2.0/user/secure-gateways.md | 4 ++-- site/content/en/v0.2.0/user/tls-passthrough.md | 4 ++-- site/content/en/v0.3.0/user/authn.md | 6 +++--- site/content/en/v0.3.0/user/http-request-headers.md | 2 +- site/content/en/v0.3.0/user/http-response-headers.md | 2 +- site/content/en/v0.3.0/user/http-traffic-splitting.md | 2 +- site/content/en/v0.3.0/user/http-urlrewrite.md | 2 +- site/content/en/v0.3.0/user/rate-limit.md | 2 +- site/content/en/v0.3.0/user/secure-gateways.md | 4 ++-- site/content/en/v0.3.0/user/tls-passthrough.md | 4 ++-- site/content/en/v0.3.0/user/udp-routing.md | 2 +- site/content/en/v0.4.0/user/authn.md | 6 +++--- site/content/en/v0.4.0/user/customize-envoyproxy.md | 2 +- site/content/en/v0.4.0/user/http-request-headers.md | 2 +- site/content/en/v0.4.0/user/http-response-headers.md | 2 +- site/content/en/v0.4.0/user/http-traffic-splitting.md | 2 +- site/content/en/v0.4.0/user/http-urlrewrite.md | 2 +- site/content/en/v0.4.0/user/rate-limit.md | 2 +- site/content/en/v0.4.0/user/secure-gateways.md | 8 ++++---- site/content/en/v0.4.0/user/tls-passthrough.md | 4 ++-- site/content/en/v0.4.0/user/udp-routing.md | 2 +- site/content/en/v0.5.0/user/authn.md | 6 +++--- site/content/en/v0.5.0/user/customize-envoyproxy.md | 2 +- site/content/en/v0.5.0/user/envoy-patch-policy.md | 2 +- site/content/en/v0.5.0/user/http-request-headers.md | 2 +- site/content/en/v0.5.0/user/http-response-headers.md | 2 +- site/content/en/v0.5.0/user/http-traffic-splitting.md | 2 +- site/content/en/v0.5.0/user/http-urlrewrite.md | 2 +- site/content/en/v0.5.0/user/proxy-observability.md | 2 +- site/content/en/v0.5.0/user/rate-limit.md | 2 +- site/content/en/v0.5.0/user/secure-gateways.md | 8 ++++---- site/content/en/v0.5.0/user/tls-cert-manager.md | 2 +- site/content/en/v0.5.0/user/tls-passthrough.md | 4 ++-- site/content/en/v0.5.0/user/tls-termination.md | 2 +- site/content/en/v0.5.0/user/udp-routing.md | 2 +- 54 files changed, 80 insertions(+), 80 deletions(-) diff --git a/site/content/en/latest/user/cors.md b/site/content/en/latest/user/cors.md index c8192c62864..b86a983a7a9 100644 --- a/site/content/en/latest/user/cors.md +++ b/site/content/en/latest/user/cors.md @@ -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 @@ -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 @@ -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: diff --git a/site/content/en/latest/user/customize-envoyproxy.md b/site/content/en/latest/user/customize-envoyproxy.md index ef894817ea6..b0ece5dd2be 100644 --- a/site/content/en/latest/user/customize-envoyproxy.md +++ b/site/content/en/latest/user/customize-envoyproxy.md @@ -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 diff --git a/site/content/en/latest/user/envoy-patch-policy.md b/site/content/en/latest/user/envoy-patch-policy.md index cd9fee24dfc..e531e584792 100644 --- a/site/content/en/latest/user/envoy-patch-policy.md +++ b/site/content/en/latest/user/envoy-patch-policy.md @@ -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 diff --git a/site/content/en/latest/user/gateway-api-metrics.md b/site/content/en/latest/user/gateway-api-metrics.md index 5331145b050..d2f93f32da6 100644 --- a/site/content/en/latest/user/gateway-api-metrics.md +++ b/site/content/en/latest/user/gateway-api-metrics.md @@ -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: diff --git a/site/content/en/latest/user/grafana-integration.md b/site/content/en/latest/user/grafana-integration.md index 4002d02633f..01010dd8009 100644 --- a/site/content/en/latest/user/grafana-integration.md +++ b/site/content/en/latest/user/grafana-integration.md @@ -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. diff --git a/site/content/en/latest/user/http-request-headers.md b/site/content/en/latest/user/http-request-headers.md index 17fe3b87bcb..0dbdbe13d3b 100644 --- a/site/content/en/latest/user/http-request-headers.md +++ b/site/content/en/latest/user/http-request-headers.md @@ -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 diff --git a/site/content/en/latest/user/http-response-headers.md b/site/content/en/latest/user/http-response-headers.md index 4a27728003d..9a0c3e38386 100644 --- a/site/content/en/latest/user/http-response-headers.md +++ b/site/content/en/latest/user/http-response-headers.md @@ -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 diff --git a/site/content/en/latest/user/http-traffic-splitting.md b/site/content/en/latest/user/http-traffic-splitting.md index 94f021b5aec..960adbcc2ea 100644 --- a/site/content/en/latest/user/http-traffic-splitting.md +++ b/site/content/en/latest/user/http-traffic-splitting.md @@ -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 diff --git a/site/content/en/latest/user/http-urlrewrite.md b/site/content/en/latest/user/http-urlrewrite.md index fb68ae88322..60c0bebeeef 100644 --- a/site/content/en/latest/user/http-urlrewrite.md +++ b/site/content/en/latest/user/http-urlrewrite.md @@ -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 diff --git a/site/content/en/latest/user/jwt-authentication.md b/site/content/en/latest/user/jwt-authentication.md index 1b6bfe0b5a6..36663f35fd2 100644 --- a/site/content/en/latest/user/jwt-authentication.md +++ b/site/content/en/latest/user/jwt-authentication.md @@ -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. @@ -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 @@ -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: diff --git a/site/content/en/latest/user/proxy-observability.md b/site/content/en/latest/user/proxy-observability.md index 5afd1064b8d..f9d8f2d5a0d 100644 --- a/site/content/en/latest/user/proxy-observability.md +++ b/site/content/en/latest/user/proxy-observability.md @@ -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: diff --git a/site/content/en/latest/user/rate-limit.md b/site/content/en/latest/user/rate-limit.md index e8a38ac7740..7b997e60226 100644 --- a/site/content/en/latest/user/rate-limit.md +++ b/site/content/en/latest/user/rate-limit.md @@ -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 diff --git a/site/content/en/latest/user/secure-gateways.md b/site/content/en/latest/user/secure-gateways.md index c2b91f0b937..dba8d3a972b 100644 --- a/site/content/en/latest/user/secure-gateways.md +++ b/site/content/en/latest/user/secure-gateways.md @@ -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 @@ -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: @@ -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. @@ -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. diff --git a/site/content/en/latest/user/tls-cert-manager.md b/site/content/en/latest/user/tls-cert-manager.md index b47d80ca5d1..2fe8112f1b5 100644 --- a/site/content/en/latest/user/tls-cert-manager.md +++ b/site/content/en/latest/user/tls-cert-manager.md @@ -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 diff --git a/site/content/en/latest/user/tls-passthrough.md b/site/content/en/latest/user/tls-passthrough.md index 4cef2eace8a..34af20e5dce 100644 --- a/site/content/en/latest/user/tls-passthrough.md +++ b/site/content/en/latest/user/tls-passthrough.md @@ -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 @@ -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: diff --git a/site/content/en/latest/user/tls-termination.md b/site/content/en/latest/user/tls-termination.md index eaae97ec9fd..eb0d2d6932c 100644 --- a/site/content/en/latest/user/tls-termination.md +++ b/site/content/en/latest/user/tls-termination.md @@ -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. diff --git a/site/content/en/latest/user/udp-routing.md b/site/content/en/latest/user/udp-routing.md index 17ba65e0f22..73a03c8aac0 100644 --- a/site/content/en/latest/user/udp-routing.md +++ b/site/content/en/latest/user/udp-routing.md @@ -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: diff --git a/site/content/en/v0.2.0/user/http-request-headers.md b/site/content/en/v0.2.0/user/http-request-headers.md index cc801d28ddc..1166f0bb668 100644 --- a/site/content/en/v0.2.0/user/http-request-headers.md +++ b/site/content/en/v0.2.0/user/http-request-headers.md @@ -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 diff --git a/site/content/en/v0.2.0/user/http-traffic-splitting.md b/site/content/en/v0.2.0/user/http-traffic-splitting.md index 421a4fa0546..e15320c02d2 100644 --- a/site/content/en/v0.2.0/user/http-traffic-splitting.md +++ b/site/content/en/v0.2.0/user/http-traffic-splitting.md @@ -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 diff --git a/site/content/en/v0.2.0/user/secure-gateways.md b/site/content/en/v0.2.0/user/secure-gateways.md index a7cb5d05acc..21f845ebf3c 100644 --- a/site/content/en/v0.2.0/user/secure-gateways.md +++ b/site/content/en/v0.2.0/user/secure-gateways.md @@ -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 @@ -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: diff --git a/site/content/en/v0.2.0/user/tls-passthrough.md b/site/content/en/v0.2.0/user/tls-passthrough.md index 73efa8d32dd..7a8a197cec2 100644 --- a/site/content/en/v0.2.0/user/tls-passthrough.md +++ b/site/content/en/v0.2.0/user/tls-passthrough.md @@ -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 @@ -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: diff --git a/site/content/en/v0.3.0/user/authn.md b/site/content/en/v0.3.0/user/authn.md index aedf5952273..312e4103b9b 100644 --- a/site/content/en/v0.3.0/user/authn.md +++ b/site/content/en/v0.3.0/user/authn.md @@ -8,7 +8,7 @@ supports validating a JWT from an HTTP header, e.g. `Authorization: Bearer