Skip to content

Commit b99d7fc

Browse files
authored
Merge branch 'main' into chore/fix-chart-yaml
2 parents 9422c71 + ce5215a commit b99d7fc

File tree

88 files changed

+2170
-1497
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

88 files changed

+2170
-1497
lines changed

Diff for: .markdownlint-cli2.yaml

+1-4
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,7 @@ config:
55
style: dash
66
no-hard-tabs: false
77
no-multiple-blanks: false
8-
line-length:
9-
line_length: 120
10-
code_blocks: false
11-
tables: false
8+
line-length: false
129
blanks-around-headers: false
1310
no-duplicate-heading:
1411
siblings_only: true

Diff for: CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Reserve GitHub issues for feature requests and bugs rather than general question
2929

3030
## Getting Started
3131

32-
Follow our [Installation Instructions](/docs/installation.md) to get the NGINX Gateway Fabric up and running.
32+
Follow our [Installation Instructions](https://docs.nginx.com/nginx-gateway-fabric/installation/) to get the NGINX Gateway Fabric up and running.
3333

3434
### Project Structure
3535

@@ -91,7 +91,7 @@ Before beginning development, familiarize yourself with the following documents:
9191
outlining guidelines and best practices to ensure smooth and efficient pull request processes.
9292
- [Go Style Guide](/docs/developer/go-style-guide.md): A coding style guide for Go. Contains best practices and
9393
conventions to follow when writing Go code for the project.
94-
- [Architecture](/docs/architecture.md): A high-level overview of the project's architecture.
94+
- [Architecture](https://docs.nginx.com/nginx-gateway-fabric/overview/gateway-architecture/): A high-level overview of the project's architecture.
9595
- [Design Principles](/docs/developer/design-principles.md): An overview of the project's design principles.
9696

9797
## Contributor License Agreement

Diff for: README.md

+9-7
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,21 @@ and `UDPRoute` -- to configure an HTTP or TCP/UDP load balancer, reverse-proxy,
1010
on Kubernetes. NGINX Gateway Fabric supports a subset of the Gateway API.
1111

1212
For a list of supported Gateway API resources and features, see
13-
the [Gateway API Compatibility](docs/gateway-api-compatibility.md) doc.
13+
the [Gateway API Compatibility](https://docs.nginx.com/nginx-gateway-fabric/gateway-api-compatibility/) doc.
1414

15-
Learn about our [design principles](/docs/developer/design-principles.md) and [architecture](/docs/architecture.md).
15+
Learn about our [design principles](/docs/developer/design-principles.md) and [architecture](https://docs.nginx.com/nginx-gateway-fabric/overview/gateway-architecture/).
1616

1717
## Getting Started
1818

19-
1. [Quick Start on a kind cluster](docs/running-on-kind.md).
20-
2. [Install](docs/installation.md) NGINX Gateway Fabric.
21-
3. [Build](docs/building-the-images.md) an NGINX Gateway Fabric container image from source or use a pre-built image
19+
1. [Quick Start on a kind cluster](https://docs.nginx.com/nginx-gateway-fabric/installation/running-on-kind/).
20+
2. [Install](https://docs.nginx.com/nginx-gateway-fabric/installation/) NGINX Gateway Fabric.
21+
3. [Build](https://docs.nginx.com/nginx-gateway-fabric/installation/building-the-images/) an NGINX Gateway Fabric container image from source or use a pre-built image
2222
available
2323
on [GitHub Container Registry](https://github.com/nginxinc/nginx-gateway-fabric/pkgs/container/nginx-gateway-fabric).
2424
4. Deploy various [examples](examples).
25-
5. Read our [guides](/docs/guides).
25+
5. Read our [How-to guides](https://docs.nginx.com/nginx-gateway-fabric/how-to/).
26+
27+
You can find the comprehensive NGINX Gateway Fabric user documentation on the [NGINX Documentation](https://docs.nginx.com/nginx-gateway-fabric/) website.
2628

2729
## NGINX Gateway Fabric Releases
2830

@@ -99,7 +101,7 @@ docker buildx imagetools inspect ghcr.io/nginxinc/nginx-gateway-fabric:edge --fo
99101

100102
## Troubleshooting
101103

102-
For troubleshooting help, see the [Troubleshooting](/docs/troubleshooting.md) document.
104+
For troubleshooting help, see the [Troubleshooting](https://docs.nginx.com/nginx-gateway-fabric/how-to/monitoring/troubleshooting/) document.
103105

104106
## Contacts
105107

Diff for: conformance/provisioner/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ manifest and **re-build** NGF.
2626

2727
How to deploy:
2828

29-
1. Follow the [installation](/docs/installation.md) instructions up until the Deploy the NGINX Gateway Fabric step
29+
1. Follow the [installation](https://docs.nginx.com/nginx-gateway-fabric/installation/) instructions up until the Deploy the NGINX Gateway Fabric step
3030
to deploy prerequisites for both the static mode Deployments and the provisioner.
3131
1. Deploy provisioner:
3232

Diff for: deploy/helm-chart/README.md

+19-12
Original file line numberDiff line numberDiff line change
@@ -32,27 +32,34 @@ This chart deploys the NGINX Gateway Fabric in your Kubernetes cluster.
3232

3333
> **Note**
3434
>
35-
> The Gateway API resources from the standard channel must be installed
36-
> before deploying NGINX Gateway Fabric. If they are already installed in your cluster, please ensure they are
37-
> the correct version as supported by the NGINX Gateway Fabric -
35+
> The [Gateway API resources](https://github.com/kubernetes-sigs/gateway-api) from the standard channel must be
36+
> installed before deploying NGINX Gateway Fabric. If they are already installed in your cluster, please ensure
37+
> they are the correct version as supported by the NGINX Gateway Fabric -
3838
> [see the Technical Specifications](https://github.com/nginxinc/nginx-gateway-fabric/blob/main/README.md#technical-specifications).
3939
40-
To install the Gateway API CRDs from [the Gateway API repo](https://github.com/kubernetes-sigs/gateway-api), run:
40+
If installing the latest stable release of NGINX Gateway Fabric, ensure you are deploying its supported version of
41+
the Gateway API resources:
4142

42-
```shell
43-
kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v1.0.0/standard-install.yaml
44-
```
43+
```shell
44+
kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v0.8.1/standard-install.yaml
45+
```
4546

46-
If you are running on Kubernetes 1.23 or 1.24, you also need to install the validating webhook. To do so, run:
47+
If you are installing the edge version of NGINX Gateway Fabric:
4748

48-
```shell
49-
kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v1.0.0/webhook-install.yaml
50-
```
49+
```shell
50+
kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v1.0.0/standard-install.yaml
51+
```
52+
53+
If you are running on Kubernetes 1.23 or 1.24, you also need to install the validating webhook. To do so, run:
54+
55+
```shell
56+
kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v1.0.0/webhook-install.yaml
57+
```
5158

5259
> **Important**
5360
>
5461
> The validating webhook is not needed if you are running Kubernetes 1.25+. Validation is done using CEL on the
55-
> CRDs. See the [resource validation doc](https://github.com/nginxinc/nginx-gateway-fabric/blob/main/docs/resource-validation.md)
62+
> CRDs. See the [resource validation doc](https://docs.nginx.com/nginx-gateway-fabric/overview/resource-validation/)
5663
> for more information.
5764
5865
## Installing the Chart

Diff for: docs/README.md

+3-20
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,10 @@
11
# NGINX Gateway Fabric Documentation
22

3-
This directory contains all of the documentation relating to NGINX Gateway Fabric.
3+
This directory contains the developer documentation and the enhancement proposals relating to NGINX Gateway Fabric.
44

5-
## Contents
6-
7-
- [Architecture](architecture.md): An overview of the architecture and design principles of NGINX Gateway Fabric.
8-
- [Gateway API Compatibility](gateway-api-compatibility.md): Describes which Gateway API resources NGINX Gateway
9-
Fabric supports and the extent of that support.
10-
- [Installation](installation.md): Walkthrough on how to install NGINX Gateway Fabric on a generic Kubernetes cluster.
11-
- [Resource Validation](resource-validation.md): Describes how NGINX Gateway Fabric validates Gateway API
12-
resources.
13-
- [Control Plane Configuration](control-plane-configuration.md): Describes how to dynamically update the NGINX
14-
Gateway Fabric control plane configuration.
15-
- [Building the Images](building-the-images.md): Steps on how to build the NGINX Gateway Fabric container images
16-
yourself.
17-
- [Running on Kind](running-on-kind.md): Walkthrough on how to run NGINX Gateway Fabric on a `kind` cluster.
18-
- [CLI Help](cli-help.md): Describes the commands available in the `gateway` binary of `nginx-gateway-fabric`
19-
container.
20-
- [Monitoring](monitoring.md): Information on monitoring NGINX Gateway Fabric using Prometheus metrics.
21-
- [Troubleshooting](troubleshooting.md): Troubleshooting guide for common or known issues.
5+
_Please note: You can find the user documentation for NGINX Gateway Fabric in the [NGINX Documentation](https://docs.nginx.com/nginx-gateway-fabric/) website._
226

23-
### Directories
7+
## Contents
248

25-
- [Guides](guides): Guides about configuring NGINX Gateway Fabric for various use cases.
269
- [Developer](developer/): Docs for developers of the project. Contains guides relating to processes and workflows.
2710
- [Proposals](proposals/): Enhancement proposals for new features.

Diff for: docs/architecture.md

-160
This file was deleted.

0 commit comments

Comments
 (0)