🎨 Refactor: docs

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

Hide file tree

Showing 49 changed files with 39 additions and 2,620 deletions.
diff --git a/GOALS.md b/GOALS.md
@@ -1,7 +1,4 @@
----
-title: "Goals"
----
-
+# Goals
 
 The high-level goal of the Envoy Gateway project is to attract more users to Envoy by lowering barriers to adoption
 through expressive, extensible, role-oriented APIs that support a multitude of ingress and L7/L4 traffic routing
@@ -11,6 +8,7 @@ fundamental interactions.
 ## Objectives
 
 ### Expressive API
+
 The Envoy Gateway project will expose a simple and expressive API, with defaults set for many capabilities.
 
 The API will be the Kubernetes-native [Gateway API][], plus Envoy-specific extensions and extension points.  This
@@ -26,6 +24,7 @@ This expressive API will not be implemented by Envoy Proxy, but rather an offici
 on top.
 
 ### Batteries included
+
 Envoy Gateway will simplify how Envoy is deployed and managed, allowing application developers to focus on
 delivering core business value.
 
@@ -40,13 +39,15 @@ will enjoy a simplified management model that doesn't require extensive knowledg
 operate.
 
 ### All environments
+
 Envoy Gateway will support running natively in Kubernetes environments as well as non-Kubernetes deployments.
 
 Initially, Kubernetes will receive the most focus, with the aim of having Envoy Gateway become the de facto
 standard for Kubernetes ingress supporting the [Gateway API][].
 Additional goals include multi-cluster support and various runtime environments.
 
 ### Extensibility
+
 Vendors will have the ability to provide value-added products built on the Envoy Gateway foundation.
 
 It will remain easy for end-users to leverage common Envoy Proxy extension points such as providing an implementation
@@ -60,21 +61,26 @@ allowing vendors to shift to a higher management plane layer.
 ## Non-objectives
 
 ### Cannibalize vendor models
+
 Vendors need to have the ability to drive commercial value, so the goal is not to cannibalize any existing vendor
 monetization model, though some vendors may be affected by it.
 
 ### Disrupt current Envoy usage patterns
+
 Envoy Gateway is purely an additive convenience layer and is not meant to disrupt any usage pattern of any user
 with Envoy Proxy, xDS, or go-control-plane.
 
 ## Personas
+
 _In order of priority_
 
 ### 1. Application developer
+
 The application developer spends the majority of their time developing business logic code.  They require the ability to
 manage access to their application.
 
 ### 2. Infrastructure administrators
+
 The infrastructure administrators are responsible for the installation, maintenance, and operation of
 API gateways appliances in infrastructure, such as CRDs, roles, service accounts, certificates, etc.
 Infrastructure administrators support the needs of application developers by managing instances of Envoy Gateway.

diff --git a/site/content/en/_index.md b/site/content/en/_index.md
@@ -6,7 +6,7 @@ title: Envoy Gateway
 <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>
-<a class="btn btn-lg btn-secondary me-3 mb-4" href="https://github.com/envoyproxy/gateway">
+<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>
 </a>
 <p class="lead mt-5">Manages Envoy Proxy as a Standalone or Kubernetes-based Application Gateway</p>
@@ -20,10 +20,11 @@ Gateway API resources are used to dynamically provision and configure the manage
 {{% /blocks/lead %}}
 
 {{% blocks/lead %}}
+Lower barriers to adoption through **Expressive, Extensible, Role-oriented APIs**
 
-The high-level goal of the Envoy Gateway project is to attract more users to Envoy by lowering barriers to adoption
-through expressive, extensible, role-oriented APIs that support a multitude of ingress and L7/L4 traffic routing
-use cases; and provide a common foundation for vendors to build value-added products without having to re-engineer
+Support a multitude of **ingress** and **L7/L4** traffic routing
+
+Common foundation for vendors to build **value-added** products without having to **re-engineer**
 fundamental interactions.
 
 {{% /blocks/lead %}}
@@ -35,7 +36,7 @@ Try Envoy Gateway in GitHub Releases
 {{% /blocks/feature %}}
 
 {{% blocks/feature icon="fab fa-github" title="Contributions Welcome!"
-    url="https://github.com/envoyproxy/gateway" %}}
+    url="/docs/contribution-guidelines/" %}}
 We do a [Pull Request](https://github.com/envoyproxy/gateway/pulls)
 contributions workflow on **GitHub**.
 {{% /blocks/feature %}}

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: 2023-10-08
+date: 2022-10-25
 description: This section includes Compatibility Matrix of Envoy Gateway.
 ---
 

diff --git a/site/content/en/blog/presentations/kubecon-eu-2023/kubecon-eu-2023.md b/site/content/en/blog/presentations/kubecon-eu-2023/kubecon-eu-2023.md
@@ -1,5 +1,6 @@
 ---
 title: "KubeCon EU 2023"
+date: 2023-05-01
 ---
 
 ## Envoy Gateway Project Update

diff --git a/site/content/en/blog/presentations/kubecon-na-2022/kubecon-na-2022.md b/site/content/en/blog/presentations/kubecon-na-2022/kubecon-na-2022.md
@@ -1,5 +1,6 @@
 ---
 title: "KubeCon NA 2022"
+date: 2022-10-28
 ---
 
 ## Envoy Gateway Project Update

diff --git a/site/content/en/community/_index.md b/site/content/en/community/_index.md
@@ -1,6 +1,6 @@
 ---
 title: Community
-menu: {main: {weight: 40}}
+menu: {main: {weight: 60}}
 ---
 
 <!--add blocks of content here to add more sections to the community page -->

diff --git a/.../content/en/docs/latest/dev/CODEOWNERS.md → ...ocs/contribution-guidelines/CODEOWNERS.md b/.../content/en/docs/latest/dev/CODEOWNERS.md → ...ocs/contribution-guidelines/CODEOWNERS.md
diff --git a/...ent/en/docs/latest/dev/CODE_OF_CONDUCT.md → ...ontribution-guidelines/CODE_OF_CONDUCT.md b/...ent/en/docs/latest/dev/CODE_OF_CONDUCT.md → ...ontribution-guidelines/CODE_OF_CONDUCT.md
@@ -1,5 +1,5 @@
 ---
-title: "Community Code of Conduct"
+title: "Code of Conduct"
 ---
 
 Gateway follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md).
diff --git a/...ontent/en/docs/v0.5.0/dev/CONTRIBUTING.md → ...s/contribution-guidelines/CONTRIBUTING.md b/...ontent/en/docs/v0.5.0/dev/CONTRIBUTING.md → ...s/contribution-guidelines/CONTRIBUTING.md
@@ -1,5 +1,6 @@
 ---
 title: "Contributing"
+weight: 3
 ---
 
 We welcome contributions from the community. Please carefully review the [project goals](GOALS.md)

diff --git a/site/content/en/docs/v0.5.0/dev/README.md → ...n/docs/contribution-guidelines/DEVELOP.md b/site/content/en/docs/v0.5.0/dev/README.md → ...n/docs/contribution-guidelines/DEVELOP.md
@@ -1,5 +1,6 @@
 ---
 title: "Developer Guide"
+weight: 2
 ---
 
 Envoy Gateway is built using a [make][]-based build system. Our CI is based on [Github Actions][] using [workflows][].

diff --git a/site/content/en/docs/latest/dev/DOCS.md → ...t/en/docs/contribution-guidelines/DOCS.md b/site/content/en/docs/latest/dev/DOCS.md → ...t/en/docs/contribution-guidelines/DOCS.md
diff --git a/site/content/en/docs/v0.3.0/dev/GOALS.md → .../contribution-guidelines/INITIAL_GOALS.md b/site/content/en/docs/v0.3.0/dev/GOALS.md → .../contribution-guidelines/INITIAL_GOALS.md
@@ -1,5 +1,6 @@
 ---
 title: "Goals"
+weight: 1
 ---
 
 The high-level goal of the Envoy Gateway project is to attract more users to Envoy by lowering barriers to adoption
@@ -10,6 +11,7 @@ fundamental interactions.
 ## Objectives
 
 ### Expressive API
+
 The Envoy Gateway project will expose a simple and expressive API, with defaults set for many capabilities.
 
 The API will be the Kubernetes-native [Gateway API][], plus Envoy-specific extensions and extension points.  This
@@ -25,6 +27,7 @@ This expressive API will not be implemented by Envoy Proxy, but rather an offici
 on top.
 
 ### Batteries included
+
 Envoy Gateway will simplify how Envoy is deployed and managed, allowing application developers to focus on
 delivering core business value.
 
@@ -39,13 +42,15 @@ will enjoy a simplified management model that doesn't require extensive knowledg
 operate.
 
 ### All environments
+
 Envoy Gateway will support running natively in Kubernetes environments as well as non-Kubernetes deployments.
 
 Initially, Kubernetes will receive the most focus, with the aim of having Envoy Gateway become the de facto
 standard for Kubernetes ingress supporting the [Gateway API][].
 Additional goals include multi-cluster support and various runtime environments.
 
 ### Extensibility
+
 Vendors will have the ability to provide value-added products built on the Envoy Gateway foundation.
 
 It will remain easy for end-users to leverage common Envoy Proxy extension points such as providing an implementation
@@ -59,21 +64,26 @@ allowing vendors to shift to a higher management plane layer.
 ## Non-objectives
 
 ### Cannibalize vendor models
+
 Vendors need to have the ability to drive commercial value, so the goal is not to cannibalize any existing vendor
 monetization model, though some vendors may be affected by it.
 
 ### Disrupt current Envoy usage patterns
+
 Envoy Gateway is purely an additive convenience layer and is not meant to disrupt any usage pattern of any user
 with Envoy Proxy, xDS, or go-control-plane.
 
 ## Personas
+
 _In order of priority_
 
 ### 1. Application developer
+
 The application developer spends the majority of their time developing business logic code.  They require the ability to
 manage access to their application.
 
 ### 2. Infrastructure administrators
+
 The infrastructure administrators are responsible for the installation, maintenance, and operation of
 API gateways appliances in infrastructure, such as CRDs, roles, service accounts, certificates, etc.
 Infrastructure administrators support the needs of application developers by managing instances of Envoy Gateway.

diff --git a/site/content/en/docs/latest/dev/releasing.md → ...docs/contribution-guidelines/RELEASING.md b/site/content/en/docs/latest/dev/releasing.md → ...docs/contribution-guidelines/RELEASING.md
diff --git a/site/content/en/docs/contribution-guidelines/_index.md b/site/content/en/docs/contribution-guidelines/_index.md
@@ -0,0 +1,5 @@
+---
+title: Get Involved
+menu: {main: {weight: 40}}
+description: "This section includes contents related to **Contributions**"
+---