🎨 Refactor: docs

Signed-off-by: bitliu <[email protected]>
envoyproxy · Oct 8, 2023 · 8edcd41 · 8edcd41
1 parent 3f27569
commit 8edcd41
Show file tree

Hide file tree

Showing 242 changed files with 3,069 additions and 258 deletions.
diff --git a/site/README.md b/site/README.md
diff --git a/site/content/en/_index.md b/site/content/en/_index.md
@@ -3,28 +3,30 @@ title: Envoy Gateway
 ---
 
 {{< blocks/cover title="Welcome to Envoy Gateway!" image_anchor="top" height="full" >}}
-<a class="btn btn-lg btn-primary me-3 mb-4" href="/docs/latest">
-  Learn More <i class="fas fa-arrow-alt-circle-right ms-2"></i>
+<a class="btn btn-lg btn-primary me-3 mb-4" href="/latest">
+  Get Started <i class="fas fa-arrow-alt-circle-right ms-2"></i>
 </a>
 <a class="btn btn-lg btn-secondary me-3 mb-4" href="https://github.com/envoyproxy/gateway/releases">
-  Download <i class="fab fa-github ms-2 "></i>
+  Contributing <i class="fas fa-pencil-alt ms-2 "></i>
 </a>
 <p class="lead mt-5">Manages Envoy Proxy as a Standalone or Kubernetes-based Application Gateway</p>
 {{< blocks/link-down color="info" >}}
 {{< /blocks/cover >}}
 
 {{% blocks/lead color="black" %}}
-Envoy Gateway is an open source project for managing Envoy Proxy as a Standalone or Kubernetes-based Application Gateway.
+Manage **Envoy Proxy** as a **Standalone** or **Kubernetes-based** Application Gateway.
 
-Gateway API resources are used to dynamically provision and configure the managed Envoy Proxies.
+**Gateway API** are used to **dynamically** provision and configure the managed Envoy Proxies.
 {{% /blocks/lead %}}
 
-{{% blocks/lead %}}
+{{% blocks/lead color="pink" %}}
 Lower barriers to adoption through **Expressive, Extensible, Role-oriented APIs**
 
 Support a multitude of **ingress** and **L7/L4** traffic routing
 
-Common foundation for vendors to build **value-added** products without having to **re-engineer**
+Common foundation for vendors to build **value-added** products
+
+Without having to **re-engineer**
 fundamental interactions.
 
 {{% /blocks/lead %}}

diff --git a/site/content/en/about/featured-background.jpg b/site/content/en/about/featured-background.jpg
diff --git a/site/content/en/about/index.md b/site/content/en/about/index.md
diff --git a/site/content/en/blog/_index.md b/site/content/en/blog/_index.md
@@ -1,6 +1,5 @@
 ---
 title: Blog
-menu: {main: {weight: 30}}
 ---
 
 This is the **blog** section. It has two categories: News and Releases.

diff --git a/site/content/en/blog/compatibility/matrix/matrix.md b/site/content/en/blog/compatibility/matrix/matrix.md
@@ -1,6 +1,6 @@
 ---
 title: Versions
-date: 2022-10-25
+date: 2022-10-01
 description: This section includes Compatibility Matrix of Envoy Gateway.
 ---
 

diff --git a/site/content/en/community/_index.md b/site/content/en/community/_index.md
diff --git a/site/content/en/docs/_index.md b/site/content/en/docs/_index.md
diff --git a/site/content/en/docs/latest/helm/_index.md b/site/content/en/docs/latest/helm/_index.md
diff --git a/site/content/en/docs/v0.5.0/_index.md b/site/content/en/docs/v0.5.0/_index.md
diff --git a/site/content/en/docs/v0.5.0/helm/_index.md b/site/content/en/docs/v0.5.0/helm/_index.md
diff --git a/site/content/en/docs/v0.4.0/_index.md → site/content/en/latest/_index.md b/site/content/en/docs/v0.4.0/_index.md → site/content/en/latest/_index.md
@@ -1,8 +1,10 @@
----
-title: "Welcome to Envoy Gateway"
-description: v0.4.0 version of Envoy Gateway
-linktitle: v0.4.0
----
++++
+title = "Welcome to Envoy Gateway"
+description = "Envoy Gateway Documents"
+
+[[cascade]]
+type = "docs"
++++
 
 Envoy Gateway is an open source project for managing **Envoy Proxy** as a standalone or Kubernetes-based application
 gateway. **Gateway API** resources are used to dynamically provision and configure the managed Envoy Proxies.
diff --git a/site/content/en/docs/latest/api/_index.md → site/content/en/latest/api/_index.md b/site/content/en/docs/latest/api/_index.md → site/content/en/latest/api/_index.md
@@ -1,4 +1,5 @@
 ---
 title: "API"
 description: This section includes APIs of Envoy Gateway.
+weight: 80
 ---
diff --git a/...ent/en/docs/latest/api/extension_types.md → .../content/en/latest/api/extension_types.md b/...ent/en/docs/latest/api/extension_types.md → .../content/en/latest/api/extension_types.md
diff --git a/...ocs/contribution-guidelines/CODEOWNERS.md → ...ent/en/latest/contributions/CODEOWNERS.md b/...ocs/contribution-guidelines/CODEOWNERS.md → ...ent/en/latest/contributions/CODEOWNERS.md
diff --git a/...ontribution-guidelines/CODE_OF_CONDUCT.md → ...n/latest/contributions/CODE_OF_CONDUCT.md b/...ontribution-guidelines/CODE_OF_CONDUCT.md → ...n/latest/contributions/CODE_OF_CONDUCT.md
diff --git a/...s/contribution-guidelines/CONTRIBUTING.md → ...t/en/latest/contributions/CONTRIBUTING.md b/...s/contribution-guidelines/CONTRIBUTING.md → ...t/en/latest/contributions/CONTRIBUTING.md
diff --git a/...n/docs/contribution-guidelines/DEVELOP.md → ...ontent/en/latest/contributions/DEVELOP.md b/...n/docs/contribution-guidelines/DEVELOP.md → ...ontent/en/latest/contributions/DEVELOP.md
diff --git a/...t/en/docs/contribution-guidelines/DOCS.md → site/content/en/latest/contributions/DOCS.md b/...t/en/docs/contribution-guidelines/DOCS.md → site/content/en/latest/contributions/DOCS.md
diff --git a/...docs/contribution-guidelines/RELEASING.md → ...tent/en/latest/contributions/RELEASING.md b/...docs/contribution-guidelines/RELEASING.md → ...tent/en/latest/contributions/RELEASING.md
diff --git a/...en/docs/contribution-guidelines/_index.md → ...content/en/latest/contributions/_index.md b/...en/docs/contribution-guidelines/_index.md → ...content/en/latest/contributions/_index.md
@@ -1,5 +1,5 @@
 ---
 title: Get Involved
-menu: {main: {weight: 40}}
 description: "This section includes contents related to **Contributions**"
+weight: 100
 ---
diff --git a/site/content/en/docs/latest/design/_index.md → site/content/en/latest/design/_index.md b/site/content/en/docs/latest/design/_index.md → site/content/en/latest/design/_index.md
diff --git a/...ontent/en/docs/latest/design/accesslog.md → site/content/en/latest/design/accesslog.md b/...ontent/en/docs/latest/design/accesslog.md → site/content/en/latest/design/accesslog.md
diff --git a/...ontent/en/docs/latest/design/bootstrap.md → site/content/en/latest/design/bootstrap.md b/...ontent/en/docs/latest/design/bootstrap.md → site/content/en/latest/design/bootstrap.md
diff --git a/...cs/latest/design/client-traffic-policy.md → ...en/latest/design/client-traffic-policy.md b/...cs/latest/design/client-traffic-policy.md → ...en/latest/design/client-traffic-policy.md
diff --git a/...ntent/en/docs/latest/design/config-api.md → site/content/en/latest/design/config-api.md b/...ntent/en/docs/latest/design/config-api.md → site/content/en/latest/design/config-api.md
diff --git a/site/content/en/docs/latest/design/egctl.md → site/content/en/latest/design/egctl.md b/site/content/en/docs/latest/design/egctl.md → site/content/en/latest/design/egctl.md
diff --git a/.../docs/latest/design/envoy-patch-policy.md → ...nt/en/latest/design/envoy-patch-policy.md b/.../docs/latest/design/envoy-patch-policy.md → ...nt/en/latest/design/envoy-patch-policy.md
diff --git a/.../latest/design/extending-envoy-gateway.md → .../latest/design/extending-envoy-gateway.md b/.../latest/design/extending-envoy-gateway.md → .../latest/design/extending-envoy-gateway.md
diff --git a/...cs/latest/design/gatewayapi-translator.md → ...en/latest/design/gatewayapi-translator.md b/...cs/latest/design/gatewayapi-translator.md → ...en/latest/design/gatewayapi-translator.md
diff --git a/.../contribution-guidelines/INITIAL_GOALS.md → site/content/en/latest/design/goals.md b/.../contribution-guidelines/INITIAL_GOALS.md → site/content/en/latest/design/goals.md
diff --git a/...docs/latest/design/local-envoy-gateway.md → ...t/en/latest/design/local-envoy-gateway.md b/...docs/latest/design/local-envoy-gateway.md → ...t/en/latest/design/local-envoy-gateway.md
diff --git a/.../content/en/docs/latest/design/metrics.md → site/content/en/latest/design/metrics.md b/.../content/en/docs/latest/design/metrics.md → site/content/en/latest/design/metrics.md
diff --git a/site/content/en/docs/latest/design/pprof.md → site/content/en/latest/design/pprof.md b/site/content/en/docs/latest/design/pprof.md → site/content/en/latest/design/pprof.md
diff --git a/...ntent/en/docs/latest/design/rate-limit.md → site/content/en/latest/design/rate-limit.md b/...ntent/en/docs/latest/design/rate-limit.md → site/content/en/latest/design/rate-limit.md
diff --git a/...s/latest/design/request-authentication.md → ...n/latest/design/request-authentication.md b/...s/latest/design/request-authentication.md → ...n/latest/design/request-authentication.md
diff --git a/.../content/en/docs/latest/design/roadmap.md → site/content/en/latest/design/roadmap.md b/.../content/en/docs/latest/design/roadmap.md → site/content/en/latest/design/roadmap.md
diff --git a/...nt/en/docs/latest/design/system-design.md → ...content/en/latest/design/system-design.md b/...nt/en/docs/latest/design/system-design.md → ...content/en/latest/design/system-design.md
diff --git a/...t/en/docs/latest/design/tcp-udp-design.md → ...ontent/en/latest/design/tcp-udp-design.md b/...t/en/docs/latest/design/tcp-udp-design.md → ...ontent/en/latest/design/tcp-udp-design.md
diff --git a/.../content/en/docs/latest/design/tracing.md → site/content/en/latest/design/tracing.md b/.../content/en/docs/latest/design/tracing.md → site/content/en/latest/design/tracing.md
diff --git a/...content/en/docs/latest/design/watching.md → site/content/en/latest/design/watching.md b/...content/en/docs/latest/design/watching.md → site/content/en/latest/design/watching.md
diff --git a/site/content/en/latest/helm/_index.md b/site/content/en/latest/helm/_index.md
@@ -0,0 +1,5 @@
+---
+title: "Installation"
+description: This section includes installation related contents of Envoy Gateway.
+weight: 70
+---
diff --git a/site/content/en/docs/latest/helm/api.md → site/content/en/latest/helm/api.md b/site/content/en/docs/latest/helm/api.md → site/content/en/latest/helm/api.md
@@ -1,5 +1,5 @@
 ---
-title: "Helm Chart Details"
+title: "Helm Chart Values"
 ---
 
 ![Version: v0.0.0-latest](https://img.shields.io/badge/Version-v0.0.0--latest-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: latest](https://img.shields.io/badge/AppVersion-latest-informational?style=flat-square)

diff --git a/...nt/en/docs/latest/images/architecture.png → ...content/en/latest/images/architecture.png b/...nt/en/docs/latest/images/architecture.png → ...content/en/latest/images/architecture.png
diff --git a/.../docs/latest/images/extension-example.png → ...nt/en/latest/images/extension-example.png b/.../docs/latest/images/extension-example.png → ...nt/en/latest/images/extension-example.png
diff --git a/site/content/en/docs/latest/user/_index.md → site/content/en/latest/user/_index.md b/site/content/en/docs/latest/user/_index.md → site/content/en/latest/user/_index.md
diff --git a/site/content/en/docs/latest/user/authn.md → site/content/en/latest/user/authn.md b/site/content/en/docs/latest/user/authn.md → site/content/en/latest/user/authn.md
diff --git a/.../docs/latest/user/customize-envoyproxy.md → ...nt/en/latest/user/customize-envoyproxy.md b/.../docs/latest/user/customize-envoyproxy.md → ...nt/en/latest/user/customize-envoyproxy.md
diff --git a/...nt/en/docs/latest/user/deployment-mode.md → ...content/en/latest/user/deployment-mode.md b/...nt/en/docs/latest/user/deployment-mode.md → ...content/en/latest/user/deployment-mode.md
diff --git a/site/content/en/docs/latest/user/egctl.md → site/content/en/latest/user/egctl.md b/site/content/en/docs/latest/user/egctl.md → site/content/en/latest/user/egctl.md
diff --git a/...en/docs/latest/user/envoy-patch-policy.md → ...tent/en/latest/user/envoy-patch-policy.md b/...en/docs/latest/user/envoy-patch-policy.md → ...tent/en/latest/user/envoy-patch-policy.md
diff --git a/...nt/en/docs/latest/user/gateway-address.md → ...content/en/latest/user/gateway-address.md b/...nt/en/docs/latest/user/gateway-address.md → ...content/en/latest/user/gateway-address.md
diff --git a/...n/docs/latest/user/gateway-api-metrics.md → ...ent/en/latest/user/gateway-api-metrics.md b/...n/docs/latest/user/gateway-api-metrics.md → ...ent/en/latest/user/gateway-api-metrics.md
diff --git a/...en/docs/latest/user/gatewayapi-support.md → ...tent/en/latest/user/gatewayapi-support.md b/...en/docs/latest/user/gatewayapi-support.md → ...tent/en/latest/user/gatewayapi-support.md
diff --git a/...ntent/en/docs/latest/user/grpc-routing.md → site/content/en/latest/user/grpc-routing.md b/...ntent/en/docs/latest/user/grpc-routing.md → site/content/en/latest/user/grpc-routing.md
diff --git a/...tent/en/docs/latest/user/http-redirect.md → site/content/en/latest/user/http-redirect.md b/...tent/en/docs/latest/user/http-redirect.md → site/content/en/latest/user/http-redirect.md
diff --git a/.../docs/latest/user/http-request-headers.md → ...nt/en/latest/user/http-request-headers.md b/.../docs/latest/user/http-request-headers.md → ...nt/en/latest/user/http-request-headers.md
diff --git a/...ocs/latest/user/http-request-mirroring.md → .../en/latest/user/http-request-mirroring.md b/...ocs/latest/user/http-request-mirroring.md → .../en/latest/user/http-request-mirroring.md
diff --git a/...docs/latest/user/http-response-headers.md → ...t/en/latest/user/http-response-headers.md b/...docs/latest/user/http-response-headers.md → ...t/en/latest/user/http-response-headers.md
diff --git a/...ntent/en/docs/latest/user/http-routing.md → site/content/en/latest/user/http-routing.md b/...ntent/en/docs/latest/user/http-routing.md → site/content/en/latest/user/http-routing.md
diff --git a/...ocs/latest/user/http-traffic-splitting.md → .../en/latest/user/http-traffic-splitting.md b/...ocs/latest/user/http-traffic-splitting.md → .../en/latest/user/http-traffic-splitting.md
diff --git a/...nt/en/docs/latest/user/http-urlrewrite.md → ...content/en/latest/user/http-urlrewrite.md b/...nt/en/docs/latest/user/http-urlrewrite.md → ...content/en/latest/user/http-urlrewrite.md
diff --git a/...ntent/en/docs/latest/user/installation.md → site/content/en/latest/user/installation.md b/...ntent/en/docs/latest/user/installation.md → site/content/en/latest/user/installation.md
diff --git a/.../docs/latest/user/multicluster-service.md → ...nt/en/latest/user/multicluster-service.md b/.../docs/latest/user/multicluster-service.md → ...nt/en/latest/user/multicluster-service.md
diff --git a/...n/docs/latest/user/proxy-observability.md → ...ent/en/latest/user/proxy-observability.md b/...n/docs/latest/user/proxy-observability.md → ...ent/en/latest/user/proxy-observability.md
diff --git a/...content/en/docs/latest/user/quickstart.md → site/content/en/latest/user/quickstart.md b/...content/en/docs/latest/user/quickstart.md → site/content/en/latest/user/quickstart.md
diff --git a/...content/en/docs/latest/user/rate-limit.md → site/content/en/latest/user/rate-limit.md b/...content/en/docs/latest/user/rate-limit.md → site/content/en/latest/user/rate-limit.md
diff --git a/...nt/en/docs/latest/user/secure-gateways.md → ...content/en/latest/user/secure-gateways.md b/...nt/en/docs/latest/user/secure-gateways.md → ...content/en/latest/user/secure-gateways.md
diff --git a/...ontent/en/docs/latest/user/tcp-routing.md → site/content/en/latest/user/tcp-routing.md b/...ontent/en/docs/latest/user/tcp-routing.md → site/content/en/latest/user/tcp-routing.md
diff --git a/...t/en/docs/latest/user/tls-cert-manager.md → ...ontent/en/latest/user/tls-cert-manager.md b/...t/en/docs/latest/user/tls-cert-manager.md → ...ontent/en/latest/user/tls-cert-manager.md
diff --git a/...nt/en/docs/latest/user/tls-passthrough.md → ...content/en/latest/user/tls-passthrough.md b/...nt/en/docs/latest/user/tls-passthrough.md → ...content/en/latest/user/tls-passthrough.md
diff --git a/...nt/en/docs/latest/user/tls-termination.md → ...content/en/latest/user/tls-termination.md b/...nt/en/docs/latest/user/tls-termination.md → ...content/en/latest/user/tls-termination.md
diff --git a/...ontent/en/docs/latest/user/udp-routing.md → site/content/en/latest/user/udp-routing.md b/...ontent/en/docs/latest/user/udp-routing.md → site/content/en/latest/user/udp-routing.md
diff --git a/site/content/en/docs/v0.2.0/_index.md → site/content/en/v0.2.0/_index.md b/site/content/en/docs/v0.2.0/_index.md → site/content/en/v0.2.0/_index.md
@@ -1,8 +1,10 @@
----
-title: "Welcome to Envoy Gateway"
-description: v0.2.0 version of Envoy Gateway
-linktitle: v0.2.0
----
++++
+title = "Welcome to Envoy Gateway"
+description = "Envoy Gateway Documents"
+
+[[cascade]]
+type = "docs"
++++
 
 Envoy Gateway is an open source project for managing **Envoy Proxy** as a standalone or Kubernetes-based application
 gateway. **Gateway API** resources are used to dynamically provision and configure the managed Envoy Proxies.
diff --git a/site/content/en/v0.2.0/contributions/CODEOWNERS.md b/site/content/en/v0.2.0/contributions/CODEOWNERS.md
@@ -0,0 +1,18 @@
+---
+title: "Maintainers"
+---
+
+## The following maintainers, listed in alphabetical order, own everything
+
+- @AliceProxy
+- @arkodg
+- @Xunzhuo
+- @zirain
+- @qicz
+
+## Emeritus Maintainers
+
+- @danehans
+- @alexgervais
+- @skriss
+- @youngnick
diff --git a/site/content/en/v0.2.0/contributions/CODE_OF_CONDUCT.md b/site/content/en/v0.2.0/contributions/CODE_OF_CONDUCT.md
@@ -0,0 +1,5 @@
+---
+title: "Code of Conduct"
+---
+
+Gateway follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md).