Update main branch with new docs structure (#1297)

* Migrate docs to docs.nginx.com (#1226)

Change docs structure and add the required files to build documentation Hugo and publish with Netlify

Rewrite existing docs to work with Hugo


---------

Co-authored-by: Travis Martin <[email protected]>
Co-authored-by: Travis Martin <[email protected]>
Co-authored-by: Kate Osborn <[email protected]>
Co-authored-by: Alan Dooley <[email protected]>
Co-authored-by: Alan Dooley <[email protected]>

* fix: fix links in github docs to d-n-c (#1291)

* Fix installation docs for mismatched versions (#1287)

Problem: Our installation docs suggested installing Gateway API v1 and NGF v1, which are not compatible.

Solution: Fix the docs to mention both stable and edge versions, with proper versioning. Also updated the release process doc to ensure these are updated at release time as needed.

* Update Control Plane Configuration documentation for Hugo formatting (#1296)

This commit updates the control plane configuration documentation to
match NGINX's standardised Hugo formatting conventions: specifically,
avoiding breaking sentences across line and the use of shortcodes for a
note. There are also some minor content changes for product noun
conventions and rephrasing a few sentences.

---------

Co-authored-by: Jon Torre <[email protected]>

* docs: update architecture doc (#1295)

* docs: update architecture doc

* chore: update architecture description

---------

Co-authored-by: Alan Dooley <[email protected]>

---------

Co-authored-by: Jon Torre <[email protected]>
Co-authored-by: Travis Martin <[email protected]>
Co-authored-by: Travis Martin <[email protected]>
Co-authored-by: Kate Osborn <[email protected]>
Co-authored-by: Alan Dooley <[email protected]>
Co-authored-by: Alan Dooley <[email protected]>

.markdownlint-cli2.yaml

@@ -5,10 +5,7 @@ config:
     style: dash
   no-hard-tabs: false
   no-multiple-blanks: false
-  line-length:
-    line_length: 120
-    code_blocks: false
-    tables: false
+  line-length: false
   blanks-around-headers: false
   no-duplicate-heading:
     siblings_only: true

CONTRIBUTING.md

@@ -29,7 +29,7 @@ Reserve GitHub issues for feature requests and bugs rather than general question
 
 ## Getting Started
 
-Follow our [Installation Instructions](/docs/installation.md) to get the NGINX Gateway Fabric up and running.
+Follow our [Installation Instructions](https://docs.nginx.com/nginx-gateway-fabric/installation/) to get the NGINX Gateway Fabric up and running.
 
 ### Project Structure
 
@@ -91,7 +91,7 @@ Before beginning development, familiarize yourself with the following documents:
   outlining guidelines and best practices to ensure smooth and efficient pull request processes.
 - [Go Style Guide](/docs/developer/go-style-guide.md): A coding style guide for Go. Contains best practices and
   conventions to follow when writing Go code for the project.
-- [Architecture](/docs/architecture.md): A high-level overview of the project's architecture.
+- [Architecture](https://docs.nginx.com/nginx-gateway-fabric/overview/gateway-architecture/): A high-level overview of the project's architecture.
 - [Design Principles](/docs/developer/design-principles.md): An overview of the project's design principles.
 
 ## Contributor License Agreement

README.md

@@ -10,19 +10,21 @@ and `UDPRoute` -- to configure an HTTP or TCP/UDP load balancer, reverse-proxy,
 on Kubernetes. NGINX Gateway Fabric supports a subset of the Gateway API.
 
 For a list of supported Gateway API resources and features, see
-the [Gateway API Compatibility](docs/gateway-api-compatibility.md) doc.
+the [Gateway API Compatibility](https://docs.nginx.com/nginx-gateway-fabric/gateway-api-compatibility/) doc.
 
-Learn about our [design principles](/docs/developer/design-principles.md) and [architecture](/docs/architecture.md).
+Learn about our [design principles](/docs/developer/design-principles.md) and [architecture](https://docs.nginx.com/nginx-gateway-fabric/overview/gateway-architecture/).
 
 ## Getting Started
 
-1. [Quick Start on a kind cluster](docs/running-on-kind.md).
-2. [Install](docs/installation.md) NGINX Gateway Fabric.
-3. [Build](docs/building-the-images.md) an NGINX Gateway Fabric container image from source or use a pre-built image
+1. [Quick Start on a kind cluster](https://docs.nginx.com/nginx-gateway-fabric/installation/running-on-kind/).
+2. [Install](https://docs.nginx.com/nginx-gateway-fabric/installation/) NGINX Gateway Fabric.
+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
    available
    on [GitHub Container Registry](https://github.com/nginxinc/nginx-gateway-fabric/pkgs/container/nginx-gateway-fabric).
 4. Deploy various [examples](examples).
-5. Read our [guides](/docs/guides).
+5. Read our [How-to guides](https://docs.nginx.com/nginx-gateway-fabric/how-to/).
+
+You can find the comprehensive NGINX Gateway Fabric user documentation on the [NGINX Documentation](https://docs.nginx.com/nginx-gateway-fabric/) website.
 
 ## NGINX Gateway Fabric Releases
 
@@ -99,7 +101,7 @@ docker buildx imagetools inspect ghcr.io/nginxinc/nginx-gateway-fabric:edge --fo
 
 ## Troubleshooting
 
-For troubleshooting help, see the [Troubleshooting](/docs/troubleshooting.md) document.
+For troubleshooting help, see the [Troubleshooting](https://docs.nginx.com/nginx-gateway-fabric/how-to/monitoring/troubleshooting/) document.
 
 ## Contacts
 

conformance/provisioner/README.md

@@ -26,7 +26,7 @@ manifest and **re-build** NGF.
 
 How to deploy:
 
-1. Follow the [installation](/docs/installation.md) instructions up until the Deploy the NGINX Gateway Fabric step
+1. Follow the [installation](https://docs.nginx.com/nginx-gateway-fabric/installation/) instructions up until the Deploy the NGINX Gateway Fabric step
    to deploy prerequisites for both the static mode Deployments and the provisioner.
 1. Deploy provisioner:
 

deploy/helm-chart/README.md

@@ -32,27 +32,34 @@ This chart deploys the NGINX Gateway Fabric in your Kubernetes cluster.
 
 > **Note**
 >
-> The Gateway API resources from the standard channel must be installed
-> before deploying NGINX Gateway Fabric. If they are already installed in your cluster, please ensure they are
-> the correct version as supported by the NGINX Gateway Fabric -
+> The [Gateway API resources](https://github.com/kubernetes-sigs/gateway-api) from the standard channel must be
+> installed before deploying NGINX Gateway Fabric. If they are already installed in your cluster, please ensure
+> they are the correct version as supported by the NGINX Gateway Fabric -
 > [see the Technical Specifications](https://github.com/nginxinc/nginx-gateway-fabric/blob/main/README.md#technical-specifications).
 
-To install the Gateway API CRDs from [the Gateway API repo](https://github.com/kubernetes-sigs/gateway-api), run:
+If installing the latest stable release of NGINX Gateway Fabric, ensure you are deploying its supported version of
+the Gateway API resources:
 
-```shell
-kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v1.0.0/standard-install.yaml
-```
+  ```shell
+  kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v0.8.1/standard-install.yaml
+  ```
 
-If you are running on Kubernetes 1.23 or 1.24, you also need to install the validating webhook. To do so, run:
+If you are installing the edge version of NGINX Gateway Fabric:
 
-```shell
-kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v1.0.0/webhook-install.yaml
-```
+  ```shell
+  kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v1.0.0/standard-install.yaml
+  ```
+
+  If you are running on Kubernetes 1.23 or 1.24, you also need to install the validating webhook. To do so, run:
+
+  ```shell
+  kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v1.0.0/webhook-install.yaml
+  ```
 
 > **Important**
 >
 > The validating webhook is not needed if you are running Kubernetes 1.25+. Validation is done using CEL on the
-> CRDs. See the [resource validation doc](https://github.com/nginxinc/nginx-gateway-fabric/blob/main/docs/resource-validation.md)
+> CRDs. See the [resource validation doc](https://docs.nginx.com/nginx-gateway-fabric/overview/resource-validation/)
 > for more information.
 
 ## Installing the Chart

docs/README.md

@@ -1,27 +1,10 @@
 # NGINX Gateway Fabric Documentation
 
-This directory contains all of the documentation relating to NGINX Gateway Fabric.
+This directory contains the developer documentation and the enhancement proposals relating to NGINX Gateway Fabric.
 
-## Contents
-
-- [Architecture](architecture.md): An overview of the architecture and design principles of NGINX Gateway Fabric.
-- [Gateway API Compatibility](gateway-api-compatibility.md): Describes which Gateway API resources NGINX Gateway
-Fabric supports and the extent of that support.
-- [Installation](installation.md): Walkthrough on how to install NGINX Gateway Fabric on a generic Kubernetes cluster.
-- [Resource Validation](resource-validation.md): Describes how NGINX Gateway Fabric validates Gateway API
-resources.
-- [Control Plane Configuration](control-plane-configuration.md): Describes how to dynamically update the NGINX
-Gateway Fabric control plane configuration.
-- [Building the Images](building-the-images.md): Steps on how to build the NGINX Gateway Fabric container images
-yourself.
-- [Running on Kind](running-on-kind.md): Walkthrough on how to run NGINX Gateway Fabric on a `kind` cluster.
-- [CLI Help](cli-help.md): Describes the commands available in the `gateway` binary of `nginx-gateway-fabric`
-container.
-- [Monitoring](monitoring.md): Information on monitoring NGINX Gateway Fabric using Prometheus metrics.
-- [Troubleshooting](troubleshooting.md): Troubleshooting guide for common or known issues.
+_Please note: You can find the user documentation for NGINX Gateway Fabric in the [NGINX Documentation](https://docs.nginx.com/nginx-gateway-fabric/) website._
 
-### Directories
+## Contents
 
-- [Guides](guides): Guides about configuring NGINX Gateway Fabric 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.