Skip to content

Add README for docs directory #968

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 14, 2023
Merged

Add README for docs directory #968

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c7e05f4
Add README for docs directory
sjberman Aug 14, 2023
80268f4
Merge branch 'main' into docs/index
sjberman Aug 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# NGINX Kubernetes Gateway Documentation

This directory contains all of the documentation relating to NGINX Kubernetes Gateway.

## Contents

- [Architecture](architecture.md): An overview of the architecture and design principles of NGINX Kubernetes Gateway.
- [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.
- [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
Kubernetes Gateway control plane configuration.
- [Building the Images](building-the-images.md): Steps on how to build the NGINX Kubernetes Gateway container images
yourself.
- [Running on Kind](running-on-kind.md): Walkthrough on how to run NGINX Kubernetes Gateway on a `kind` cluster.
- [CLI Help](cli-help.md): Describes the commands available in the `gateway` binary of `nginx-kubernetes-gateway`
container.

### Directories

- [Developer](developer/): Docs for developers of the project. Contains guides relating to processes and workflows.
- [Proposals](proposals/): Enhancement proposals for new features.