Skip to content

Commit

Permalink
Add an index page for guides (#990)
Browse files Browse the repository at this point in the history
Problem:
The doc index page (docs/README.md) doesn't include any guides

Solution:
- Add an index page for the guides
- Add a link to the guides directory from the main index page.

Testing: none
  • Loading branch information
pleshakov authored Aug 18, 2023
1 parent 73dc8b0 commit 4795b18
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,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.
10 changes: 10 additions & 0 deletions docs/guides/README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 4795b18

Please sign in to comment.