Skip to content

Commit b59e69e

Browse files
committed
Add README for docs directory (nginx#968)
1 parent aa6bce7 commit b59e69e

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

docs/README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# NGINX Kubernetes Gateway Documentation
2+
3+
This directory contains all of the documentation relating to NGINX Kubernetes Gateway.
4+
5+
## Contents
6+
7+
- [Architecture](architecture.md): An overview of the architecture and design principles of NGINX Kubernetes Gateway.
8+
- [Gateway API Compatibility](gateway-api-compatibility.md): Describes which Gateway API resources NGINX Kubernetes
9+
Gateway supports and the extent of that support.
10+
- [Installation](installation.md): Walkthrough on how to install NGINX Kubernetes Gateway on a generic Kubernetes cluster.
11+
- [Resource Validation](resource-validation.md): Describes how NGINX Kubernetes Gateway validates Gateway API
12+
resources.
13+
- [Control Plane Configuration](control-plane-configuration.md): Describes how to dynamically update the NGINX
14+
Kubernetes Gateway control plane configuration.
15+
- [Building the Images](building-the-images.md): Steps on how to build the NGINX Kubernetes Gateway container images
16+
yourself.
17+
- [Running on Kind](running-on-kind.md): Walkthrough on how to run NGINX Kubernetes Gateway on a `kind` cluster.
18+
- [CLI Help](cli-help.md): Describes the commands available in the `gateway` binary of `nginx-kubernetes-gateway`
19+
container.
20+
21+
### Directories
22+
23+
- [Developer](developer/): Docs for developers of the project. Contains guides relating to processes and workflows.
24+
- [Proposals](proposals/): Enhancement proposals for new features.

0 commit comments

Comments
 (0)