Skip to content

Commit 7c87b0f

Browse files
committed
Cleans-Up Docs
Signed-off-by: danehans <[email protected]>
1 parent 976366f commit 7c87b0f

File tree

10 files changed

+30
-54
lines changed

10 files changed

+30
-54
lines changed

docs/latest/about_docs.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
About the documentation
1+
About the Documentation
22
=======================
33

44
Learn how to contribute to Envoy Gateway documentation.

docs/latest/get_involved.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Getting involved
1+
Getting Involved
22
================
33

44
We welcome contributions from the community. Please carefully review the

docs/latest/index.rst

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,19 @@
11
`Envoy Gateway </>`_
22
=============
33

4-
Release |version|
4+
Release: |version|
55

66
.. image:: https://img.shields.io/badge/slack-join-orange.svg
77
:target: https://envoyproxy.slack.com/archives/C03E6NHLESV
88
:alt: Join the Envoy Slack
99

10-
Envoy Gateway is an open source project for managing Envoy Proxy as a
11-
standalone or Kubernetes-based application gateway.
12-
13-
.. note::
14-
15-
This project is under active development. Many, many features are not
16-
complete. We would love for you to :doc:`get involved<get_involved>`.
10+
Envoy Gateway is an open source project for managing `Envoy Proxy`_ as a standalone or Kubernetes-based application
11+
gateway. `Gateway API`_ resources are used to dynamically provision and configure the managed Envoy Proxies. Whether
12+
you are interested in using or contributing to Envoy Gateway, the following resources will help you get started:
1713

1814
.. toctree::
1915
:maxdepth: 1
2016

21-
intro/index
2217
intro/compatibility
2318
user_docs
2419
design_docs
@@ -27,3 +22,11 @@ standalone or Kubernetes-based application gateway.
2722
roadmap
2823
about_docs
2924
get_involved
25+
26+
.. note::
27+
28+
This project is under active development. Many, many features are not
29+
complete. We would love for you to :doc:`get involved<get_involved>`.
30+
31+
.. _Envoy Proxy: https://www.envoyproxy.io/
32+
.. _Gateway API: https://gateway-api.sigs.k8s.io/

docs/latest/intro/index.rst

Lines changed: 0 additions & 15 deletions
This file was deleted.

docs/latest/user_docs.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ User Guides
44
Learn how to deploy, use, and operate Envoy Gateway.
55

66
.. toctree::
7-
:maxdepth: 2
7+
:maxdepth: 1
88

99
user/quickstart
1010
user/http-routing

docs/v0.2.0/about_docs.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
About the documentation
1+
About the Documentation
22
=======================
33

44
Learn how to contribute to Envoy Gateway documentation.

docs/v0.2.0/get_involved.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Getting involved
1+
Getting Involved
22
================
33

44
We welcome contributions from the community. Please carefully review the

docs/v0.2.0/index.rst

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,19 @@
11
`Envoy Gateway </>`_
22
=============
33

4-
Release |version|
4+
Release: |version|
55

66
.. image:: https://img.shields.io/badge/slack-join-orange.svg
77
:target: https://envoyproxy.slack.com/archives/C03E6NHLESV
88
:alt: Join the Envoy Slack
99

10-
Envoy Gateway is an open source project for managing Envoy Proxy as a
11-
standalone or Kubernetes-based application gateway.
12-
13-
.. note::
14-
15-
This project is under active development. Many, many features are not
16-
complete. We would love for you to :doc:`get involved<get_involved>`.
10+
Envoy Gateway is an open source project for managing `Envoy Proxy`_ as a standalone or Kubernetes-based application
11+
gateway. `Gateway API`_ resources are used to dynamically provision and configure the managed Envoy Proxies. Whether
12+
you are interested in using or contributing to Envoy Gateway, the following resources will help you get started:
1713

1814
.. toctree::
1915
:maxdepth: 1
2016

21-
intro/index
2217
intro/compatibility
2318
user_docs
2419
design_docs
@@ -27,3 +22,11 @@ standalone or Kubernetes-based application gateway.
2722
roadmap
2823
about_docs
2924
get_involved
25+
26+
.. note::
27+
28+
This project is under active development. Many, many features are not
29+
complete. We would love for you to :doc:`get involved<get_involved>`.
30+
31+
.. _Envoy Proxy: https://www.envoyproxy.io/
32+
.. _Gateway API: https://gateway-api.sigs.k8s.io/

docs/v0.2.0/intro/index.rst

Lines changed: 0 additions & 15 deletions
This file was deleted.

docs/v0.2.0/user_docs.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ User Guides
44
Learn how to deploy, use, and operate Envoy Gateway.
55

66
.. toctree::
7-
:maxdepth: 2
7+
:maxdepth: 1
88

99
user/quickstart
1010
user/http-routing

0 commit comments

Comments
 (0)