Migrate docs to docs.nginx.com

.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

docs/README.md

@@ -1,27 +1,8 @@
 # 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.
-
-### Directories
-
-- [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.

docs/developer/documentation.md

@@ -0,0 +1,163 @@
+# NGINX Gateway Fabric Docs
+
+The `/site` directory contains the user documentation for NGINX Gateway Fabric and the requirements for linting, building, and publishing the docs. Run all the `hugo` commands below from this directory.
+
+We use [Hugo](https://gohugo.io/) to build the docs for NGINX, with the [nginx-hugo-theme](https://github.com/nginxinc/nginx-hugo-theme).
+
+Docs should be written in Markdown.
+
+In the `/site` directory, you will find the following files:
+
+- a [Netlify](https://netlify.com) configuration file;
+- configuration files for [markdownlint](https://github.com/DavidAnson/markdownlint/) and [markdown-link-check](https://github.com/tcort/markdown-link-check)
+- a `./config` directory that contains the [Hugo](https://gohugo.io) configuration.
+
+## Git Guidelines
+
+See the [Pull Request Guide](pull-request.md) for specfic instructions on how to submit a pull request.
+
+### Branching and Workflow
+
+This repo uses a [forking workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/forking-workflow). See our [Branching and Workflow](branching-and-workflow.md) documentation for more information.
+
+### Publishing Documentation Updates
+
+**`main`** is the default branch in this repo. All the latest content updates are merged into this branch. 
+
+The documentation is published from the latest public release branch, (for example, `release-4.0`). Work on your docs in a feature branch in your fork of the repo. Open pull requests into the `main` branch when you are ready to merge your work.
+
+If you are working on content for immediate publication in the docs site, cherrypick your changes to the current public release branch.
+
+If you are working on content for a future release, make sure that you **do not** cherrypick them to the current public release branch, as this will publish them automatically. See the [Release Process documentation](release-process.md) for more information.
+
+
+## Setup
+
+### Golang
+
+Follow the instructions here to install Go: https://golang.org/doc/install
+
+> To support the use of Hugo mods, you need to install Go v1.15 or newer.
+
+### Hugo
+
+Follow the instructions here to install Hugo: [Hugo Installation](https://gohugo.io/installation/)
+
+> **NOTE:** We are currently running [Hugo v0.115.3](https://github.com/gohugoio/hugo/releases/tag/v0.115.3) in production.
+
+### Markdownlint
+
+We use markdownlint to check that Markdown files are correctly formatted. You can use `npm` to install markdownlint-cli:
+
+```
+npm install -g markdownlint-cli   
+```
+
+## How to write docs with Hugo
+
+### Add a new doc
+
+- To create a new doc that contains all of the pre-configured Hugo front-matter and the docs task template:
+
+    `hugo new <SECTIONNAME>/<FILENAME>.<FORMAT>`
+
+  e.g.,
+
+    hugo new install.md
+
+  > The default template -- task -- should be used in most docs.
+- To create other types of docs, you can add the `--kind` flag:
+    `hugo new tutorials/deploy.md --kind tutorial`
+
+
+The available kinds are:
+
+- Task: Enable the customer to achieve a specific goal, based on use case scenarios.
+- Concept: Help a customer learn about a specific feature or feature set.
+- Reference: Describes an API, command line tool, config options, etc.; should be generated automatically from source code. 
+- Troubleshooting: Helps a customer solve a specific problem.
+- Tutorial: Walk a customer through an example use case scenario; results in a functional PoC environment.
+
+### Format internal links
+
+Format links as [Hugo relrefs](https://gohugo.io/content-management/cross-references/). 
+
+> Note: Using file extensions when linking to internal docs with `relref` is optional.
+
+- You can use relative paths or just the filename. We recommend using the filename
+- Paths without a leading `/` are first resolved relative to the current page, then to the remainder of the site.
+- Anchors are supported.
+
+For example:
+
+```md
+To install NGINX Gateway Fabric, refer to the [installation instructions]({{< relref "/installation/install.md#section-1" >}}).
+```
+
+### Add images
+
+You can use the `img` [shortcode](#shortcodes) to insert images into your documentation.
+
+1. Add the image to the static/img directory.
+   DO NOT include a forward slash at the beginning of the file path. This will break the image when it's rendered.
+   See the docs for the [Hugo relURL Function](https://gohugo.io/functions/relurl/#input-begins-with-a-slash) to learn more.
+
+1. Add the img shortcode:
+
+    {{< img src="img/<img-file.png>" >}}
+
+> Note: The shortcode accepts all of the same parameters as the [Hugo figure shortcode](https://gohugo.io/content-management/shortcodes/#figure). 
+
+### Use Hugo shortcodes
+You can use Hugo [shortcodes](https://gohugo.io/content-management/shortcodes) to do things like format callouts, add images, and reuse content across different docs. 
+
+For example, to use the note callout:
+
+```md
+{{< note >}}Provide the text of the note here. {{< /note >}}
+``` 
+
+The callout shortcodes also support multi-line blocks:
+
+```md
+{{< caution >}}
+You should probably never do this specific thing in a production environment. If you do, and things break, don't say we didn't warn you.
+{{< /caution >}}
+```
+
+Supported callouts:
+- caution
+- important
+- note
+- see-also
+- tip
+- warning
+
+A few more useful shortcodes:
+
+- collapse: makes a section collapsible
+- table: adds scrollbars to wide tables when viewed in small browser windows or mobile browsers
+- fa: inserts a Font Awesome icon
+- include: include the content of a file in another file (requires the included file to be in the /includes directory)
+- link: makes it possible to link to a static file and prepend the path with the Hugo baseUrl
+- openapi: loads an OpenAPI spec and renders as HTML using ReDoc
+- raw-html: makes it possible to include a block of raw HTML
+- readfile: includes the content of another file in the current file; useful for adding code examples
+
+## How to build docs locally
+
+To view the docs in a browser, run the Hugo server. This will reload the docs automatically so you can view updates as you work.
+
+> Note: The docs use build environments to control the baseURL that will be used for things like internal references and resource (CSS and JS) loading. 
+> You can view the config for each environment in the [config](./config) directory of this repo.
+When running the Hugo server, you can specify the environment and baseURL if desired, but it's not necessary.
+
+For example:
+
+```
+hugo server
+```
+
+```
+hugo server -e development -b "http://127.0.0.1/nginx-gateway-fabric/"
+```

docs/developer/implementing-a-feature.md

@@ -32,18 +32,19 @@ practices to ensure a successful feature development process.
    the [testing](/docs/developer/testing.md#unit-test-guidelines) documentation.
 9. **Manually verify your changes**: Refer to the [manual testing](/docs/developer/testing.md#manual-testing) section of
    the testing documentation for instructions on how to manually test your changes.
-10. **Update any relevant documentation**: Here are some guidelines for updating documentation:
+10. **Update any relevant documentation**: See the [documentation](/docs/developer/documentation.md) guide for in-depth information about the workflow to update the docs and how we publish them.
+   Here are some basic guidelines for updating documentation:
     - **Gateway API Feature**: If you are implementing a Gateway API feature, make sure to update
-      the [Gateway API Compatibility](/docs/gateway-api-compatibility.md) documentation.
+      the [Gateway API Compatibility](/site/content/concepts/gateway-api-compatibility.md) documentation.
     - **New Use Case:** If your feature introduces a new use case, add an example of how to use it in
       the [examples](/examples) directory. This example will help users understand how to leverage the new feature.
       > For security, a Docker image used in an example must be either managed by F5/NGINX or be an [official image](https://docs.docker.com/docker-hub/official_images/).
     - **Installation Changes**: If your feature involves changes to the installation process of NGF, update
-      the [installation](/docs/installation.md) documentation.
+      the [installation](/site/content/how-to/installation/installation.md) documentation.
     - **Helm Changes**: If your feature introduces or changes any values of the NGF Helm Chart, update the
       [Helm README](/deploy/helm-chart/README.md).
     - **Command-line Changes**: If your feature introduces or changes a command-line flag or subcommand, update
-      the [cli help](/docs/cli-help.md) documentation.
+      the [cli help](/site/content/reference/cli-help.md) documentation.
     - **Other Documentation Updates**: For any other changes that affect the behavior, usage, or configuration of NGF,
       review the existing documentation and update it as necessary. Ensure that the documentation remains accurate and
       up to date with the latest changes.