From 02a337218a3da13f869b16d26d8ba3e68d91137c Mon Sep 17 00:00:00 2001 From: Michael Pleshakov Date: Fri, 18 Aug 2023 11:59:33 -0400 Subject: [PATCH 1/2] Include guides into the doc index page Problem: The doc index page (docs/README.md) doesn't include any guides Solution: Add the guides to the index page. Alternatives considered: Add an index (README.md) in the docs/guide directory and reference it from docs/README.md. However, with this approach the guides will be less visible on the docs/README.md page. Testing: none --- README.md | 2 +- docs/README.md | 5 +++++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8f4625994..c34b9a60d 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ Learn about our [design principles](/docs/developer/design-principles.md) and [a available on [GitHub Container Registry](https://github.com/nginxinc/nginx-kubernetes-gateway/pkgs/container/nginx-kubernetes-gateway). 4. Deploy various [examples](examples). -5. Read our [guides](/docs/guides). +5. Explore our [documentation and guides](docs). ## NGINX Kubernetes Gateway Releases diff --git a/docs/README.md b/docs/README.md index 01adc26b2..a85f01da4 100644 --- a/docs/README.md +++ b/docs/README.md @@ -8,6 +8,11 @@ This directory contains all of the documentation relating to NGINX Kubernetes Ga - [Gateway API Compatibility](gateway-api-compatibility.md): Describes which Gateway API resources NGINX Kubernetes Gateway supports and the extent of that support. - [Installation](installation.md): Walkthrough on how to install NGINX Kubernetes Gateway on a generic Kubernetes cluster. +- Guides: + - [Securing Traffic using Let's Encrypt and Cert-Manager](guides/integrating-cert-manager.md): Shows how to secure + traffic from clients to NGINX Kubernetes Gateway with TLS using Let's Encrypt and Cert-Manager. + - [Using NGINX Kubernetes Gateway to Upgrade Applications without Downtime](guides/upgrade-apps-without-downtime.md): + Explains how to use NGINX Kubernetes Gateway to upgrade applications without downtime. - [Resource Validation](resource-validation.md): Describes how NGINX Kubernetes Gateway validates Gateway API resources. - [Control Plane Configuration](control-plane-configuration.md): Describes how to dynamically update the NGINX From e4c8f46452481d8af64a203beefb262d40456fd9 Mon Sep 17 00:00:00 2001 From: Michael Pleshakov Date: Fri, 18 Aug 2023 14:25:37 -0400 Subject: [PATCH 2/2] Add index page for guides --- README.md | 2 +- docs/README.md | 6 +----- docs/guides/README.md | 10 ++++++++++ 3 files changed, 12 insertions(+), 6 deletions(-) create mode 100644 docs/guides/README.md diff --git a/README.md b/README.md index c34b9a60d..8f4625994 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ Learn about our [design principles](/docs/developer/design-principles.md) and [a available on [GitHub Container Registry](https://github.com/nginxinc/nginx-kubernetes-gateway/pkgs/container/nginx-kubernetes-gateway). 4. Deploy various [examples](examples). -5. Explore our [documentation and guides](docs). +5. Read our [guides](/docs/guides). ## NGINX Kubernetes Gateway Releases diff --git a/docs/README.md b/docs/README.md index a85f01da4..ae6a47efd 100644 --- a/docs/README.md +++ b/docs/README.md @@ -8,11 +8,6 @@ This directory contains all of the documentation relating to NGINX Kubernetes Ga - [Gateway API Compatibility](gateway-api-compatibility.md): Describes which Gateway API resources NGINX Kubernetes Gateway supports and the extent of that support. - [Installation](installation.md): Walkthrough on how to install NGINX Kubernetes Gateway on a generic Kubernetes cluster. -- Guides: - - [Securing Traffic using Let's Encrypt and Cert-Manager](guides/integrating-cert-manager.md): Shows how to secure - traffic from clients to NGINX Kubernetes Gateway with TLS using Let's Encrypt and Cert-Manager. - - [Using NGINX Kubernetes Gateway to Upgrade Applications without Downtime](guides/upgrade-apps-without-downtime.md): - Explains how to use NGINX Kubernetes Gateway to upgrade applications without downtime. - [Resource Validation](resource-validation.md): Describes how NGINX Kubernetes Gateway validates Gateway API resources. - [Control Plane Configuration](control-plane-configuration.md): Describes how to dynamically update the NGINX @@ -25,5 +20,6 @@ container. ### Directories +- [Guides](guides): Guides about configuring NGINX Kubernetes Gateway for various use cases. - [Developer](developer/): Docs for developers of the project. Contains guides relating to processes and workflows. - [Proposals](proposals/): Enhancement proposals for new features. diff --git a/docs/guides/README.md b/docs/guides/README.md new file mode 100644 index 000000000..60ca218e3 --- /dev/null +++ b/docs/guides/README.md @@ -0,0 +1,10 @@ +# Guides + +This directory contains guides for configuring NGINX Kubernetes Gateway for various use cases. + +## Contents + +- [Securing Traffic using Let's Encrypt and Cert-Manager](integrating-cert-manager.md): Shows how to secure + traffic from clients to NGINX Kubernetes Gateway with TLS using Let's Encrypt and Cert-Manager. +- [Using NGINX Kubernetes Gateway to Upgrade Applications without Downtime](upgrade-apps-without-downtime.md): + Explains how to use NGINX Kubernetes Gateway to upgrade applications without downtime.