Cleans-Up Docs (envoyproxy#640)

Signed-off-by: danehans <daneyonhansen@gmail.com>
arkodg · Nov 5, 2022 · 54d44d5 · 54d44d5
1 parent 976366f
commit 54d44d5
Show file tree

Hide file tree

Showing 10 changed files with 30 additions and 54 deletions.
diff --git a/docs/latest/about_docs.rst b/docs/latest/about_docs.rst
@@ -1,4 +1,4 @@
-About the documentation
+About the Documentation
 =======================
 
 Learn how to contribute to Envoy Gateway documentation.

diff --git a/docs/latest/get_involved.rst b/docs/latest/get_involved.rst
@@ -1,4 +1,4 @@
-Getting involved
+Getting Involved
 ================
 
 We welcome contributions from the community. Please carefully review the

diff --git a/docs/latest/index.rst b/docs/latest/index.rst
@@ -1,24 +1,19 @@
 `Envoy Gateway </>`_
 =============
 
-Release |version|
+Release: |version|
 
 .. image:: https://img.shields.io/badge/slack-join-orange.svg
     :target: https://envoyproxy.slack.com/archives/C03E6NHLESV
     :alt: Join the Envoy Slack
 
-Envoy Gateway is an open source project for managing Envoy Proxy as a
-standalone or Kubernetes-based application gateway.
-
-.. note::
-
-   This project is under active development. Many, many features are not
-   complete. We would love for you to :doc:`get involved<get_involved>`.
+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. Whether
+you are interested in using or contributing to Envoy Gateway, the following resources will help you get started:
 
 .. toctree::
   :maxdepth: 1
 
-  intro/index
   intro/compatibility
   user_docs
   design_docs
@@ -27,3 +22,11 @@ standalone or Kubernetes-based application gateway.
   roadmap
   about_docs
   get_involved
+
+.. note::
+
+   This project is under active development. Many, many features are not
+   complete. We would love for you to :doc:`get involved<get_involved>`.
+
+.. _Envoy Proxy: https://www.envoyproxy.io/
+.. _Gateway API: https://gateway-api.sigs.k8s.io/
diff --git a/docs/latest/intro/index.rst b/docs/latest/intro/index.rst
diff --git a/docs/latest/user_docs.rst b/docs/latest/user_docs.rst
@@ -4,7 +4,7 @@ User Guides
 Learn how to deploy, use, and operate Envoy Gateway.
 
 .. toctree::
-  :maxdepth: 2
+  :maxdepth: 1
 
   user/quickstart
   user/http-routing

diff --git a/docs/v0.2.0/about_docs.rst b/docs/v0.2.0/about_docs.rst
@@ -1,4 +1,4 @@
-About the documentation
+About the Documentation
 =======================
 
 Learn how to contribute to Envoy Gateway documentation.

diff --git a/docs/v0.2.0/get_involved.rst b/docs/v0.2.0/get_involved.rst
@@ -1,4 +1,4 @@
-Getting involved
+Getting Involved
 ================
 
 We welcome contributions from the community. Please carefully review the

diff --git a/docs/v0.2.0/index.rst b/docs/v0.2.0/index.rst
@@ -1,24 +1,19 @@
 `Envoy Gateway </>`_
 =============
 
-Release |version|
+Release: |version|
 
 .. image:: https://img.shields.io/badge/slack-join-orange.svg
     :target: https://envoyproxy.slack.com/archives/C03E6NHLESV
     :alt: Join the Envoy Slack
 
-Envoy Gateway is an open source project for managing Envoy Proxy as a
-standalone or Kubernetes-based application gateway.
-
-.. note::
-
-   This project is under active development. Many, many features are not
-   complete. We would love for you to :doc:`get involved<get_involved>`.
+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. Whether
+you are interested in using or contributing to Envoy Gateway, the following resources will help you get started:
 
 .. toctree::
   :maxdepth: 1
 
-  intro/index
   intro/compatibility
   user_docs
   design_docs
@@ -27,3 +22,11 @@ standalone or Kubernetes-based application gateway.
   roadmap
   about_docs
   get_involved
+
+.. note::
+
+   This project is under active development. Many, many features are not
+   complete. We would love for you to :doc:`get involved<get_involved>`.
+
+.. _Envoy Proxy: https://www.envoyproxy.io/
+.. _Gateway API: https://gateway-api.sigs.k8s.io/
diff --git a/docs/v0.2.0/intro/index.rst b/docs/v0.2.0/intro/index.rst
diff --git a/docs/v0.2.0/user_docs.rst b/docs/v0.2.0/user_docs.rst
@@ -4,7 +4,7 @@ User Guides
 Learn how to deploy, use, and operate Envoy Gateway.
 
 .. toctree::
-  :maxdepth: 2
+  :maxdepth: 1
 
   user/quickstart
   user/http-routing