feat: Remove duplicate includes folder, update frontmatter

This commit removes an accidental duplicate of the includes folder, and
updates the frontmatter of every single page in the documentation set.
They are now all consistent in their fields and formatting, and a
handful of IA or heading changes have been made as low-hanging fruit to
bring the documentation set closer to full consistency.

Author: ADubhlaoich

content/ngf/changelog.md

@@ -1,7 +1,9 @@
 ---
 title: Get started
-toc: true
 weight: 200
+toc: true
+type: how-to
+product: NGF
 docs: DOCS-000
 ---
 

content/ngf/get-started.md

@@ -1,7 +1,7 @@
 ---
-title: "Control plane configuration"
-toc: true
+title: Control plane configuration
 weight: 400
+toc: true
 type: how-to
 product: NGF
 docs: DOCS-1416
@@ -26,6 +26,8 @@ Additionally, the control plane updates the status of the resource (if it exists
 
 **For a full list of configuration options that can be set, see the `NginxGateway spec` in the [API reference]({{< ref "/ngf/reference/api.md" >}}).**
 
+---
+
 ## Viewing and Updating the Configuration
 
 {{< note >}} For the following examples, the name `ngf-config` should be updated to the name of the resource created for your installation.{{< /note >}}

content/ngf/how-to/control-plane-configuration.md

@@ -1,7 +1,7 @@
 ---
-title: "Data plane configuration"
-toc: true
+title: Data plane configuration
 weight: 500
+toc: true
 type: how-to
 product: NGF
 docs: DOCS-000
@@ -23,11 +23,13 @@ When installed using the Helm chart, the NginxProxy resource is named `<release-
 
 {{< note >}} Some global configuration also requires an [associated policy]({{< ref "/ngf/overview/custom-policies.md" >}}) to fully enable a feature (such as [tracing]({{< ref "/ngf/how-to/monitoring/tracing.md" >}}), for example). {{< /note >}}
 
+---
+
 ## Viewing and Updating the Configuration
 
 If the `NginxProxy` resource already exists, you can view and edit it.
 
-{{< note >}} For the following examples, the name `ngf-proxy-config` should be updated to the name of the resource created for your installation.{{< /note >}}
+{{< note >}} For the following examples, the name `ngf-proxy-config` should be updated to the name of the resource created for your installation. {{< /note >}}
 
 To view the current configuration:
 
@@ -63,7 +65,9 @@ Status:
 
 If everything is valid, the `ResolvedRefs` condition should be `True`. Otherwise, you will see an `InvalidParameters` condition in the status.
 
-## Manually Creating the Configuration
+---
+
+## Manually create the configuration
 
 If the `NginxProxy` resource doesn't exist, you can create it and attach it to the GatewayClass.
 
@@ -115,7 +119,9 @@ Status:
 
 If everything is valid, the `ResolvedRefs` condition should be `True`. Otherwise, you will see an `InvalidParameters` condition in the status.
 
-## Configure the Data Plane Log Level
+---
+
+## Configure the data plane log level
 
 You can use the `NginxProxy` resource to dynamically configure the Data Plane Log Level.
 
@@ -141,6 +147,8 @@ To view the full list of supported log levels, see the `NginxProxy spec` in the
 be [run with NGINX in debug mode](#run-nginx-gateway-fabric-with-nginx-in-debug-mode) upon startup through the addition
 of a few arguments. {{</ note >}}
 
+---
+
 ### Run NGINX Gateway Fabric with NGINX in debug mode
 
 To run NGINX Gateway Fabric with NGINX in debug mode, follow the [installation document]({{< ref "/ngf/installation/installing-ngf" >}}) with these additional steps:
@@ -160,6 +168,8 @@ as arguments and add `/bin/sh` as the command. The deployment manifest should lo
 ...
 ```
 
+---
+
 ## Configure PROXY protocol and RewriteClientIP settings
 
 When a request is passed through multiple proxies or load balancers, the client IP is set to the IP address of the server that last handled the request. To preserve the original client IP address, you can configure `RewriteClientIP` settings in the `NginxProxy` resource. `RewriteClientIP` has the fields: _mode_, _trustedAddresses_ and _setIPRecursively_.

content/ngf/how-to/data-plane-configuration.md

@@ -1,12 +1,16 @@
 ---
-title: "NGINX Plus dashboard"
+title: NGINX Plus dashboard
 weight: 300
 toc: true
-docs: "DOCS-1417"
+type: how-to
+product: NGF
+docs: DOCS-1417
 ---
 
 Learn how to view the NGINX Plus dashboard to see real-time metrics.
 
+---
+
 ## Overview
 
 The NGINX Plus dashboard offers a real-time live activity monitoring interface that shows key load and performance metrics of your server infrastructure. The dashboard is enabled by default for NGINX Gateway Fabric deployments that use NGINX Plus as the data plane. The dashboard is available on port 8765.
@@ -25,4 +29,4 @@ The dashboard will look like this:
 
 {{< img src="/ngf/img/nginx-plus-dashboard.png" alt="">}}
 
-{{< note >}}The [API](https://nginx.org/en/docs/http/ngx_http_api_module.html) used by the dashboard for metrics is also accessible using the `/api` path. {{< /note >}}
+{{< note >}} The [API](https://nginx.org/en/docs/http/ngx_http_api_module.html) used by the dashboard for metrics is also accessible using the `/api` path. {{< /note >}}

content/ngf/how-to/monitoring/dashboard.md

@@ -1,23 +1,29 @@
 ---
-title: "Prometheus metrics"
-weight: 100
+title: Monitoring with Prometheus and Grafana
+weight: 200
 toc: true
-docs: "DOCS-1418"
+type: how-to
+product: NGF
+docs: DOCS-1418
 ---
 
 This document describes how to monitor NGINX Gateway Fabric using Prometheus and Grafana. It explains installation and configuration, as well as what metrics are available.
 
+---
+
 ## Overview
 
 NGINX Gateway Fabric metrics are displayed in [Prometheus](https://prometheus.io/) format. These metrics are served through a metrics server orchestrated by the controller-runtime package on HTTP port `9113`. When installed, Prometheus automatically scrapes this port and collects metrics. [Grafana](https://grafana.com/) can be used for rich visualization of these metrics.
 
-{{<call-out "important" "Security note for metrics">}}
+{{< call-out "important" "Security note for metrics" >}}
 Metrics are served over HTTP by default. Enabling HTTPS will secure the metrics endpoint with a self-signed certificate. When using HTTPS, adjust the Prometheus Pod scrape settings by adding the `insecure_skip_verify` flag to handle the self-signed certificate. For further details, refer to the [Prometheus documentation](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#tls_config).
-{{</call-out>}}
+{{< /call-out >}}
+
+---
 
 ## Installing Prometheus and Grafana
 
-{{< note >}}These installations are for demonstration purposes and have not been tuned for a production environment.{{< /note >}}
+{{< note >}} These installations are for demonstration purposes and have not been tuned for a production environment. {{< /note >}}
 
 ### Prometheus
 
@@ -35,8 +41,9 @@ kubectl port-forward -n monitoring svc/prometheus-server 9090:80 &
 
 Visit [http://127.0.0.1:9090](http://127.0.0.1:9090) to view the dashboard.
 
-### Grafana
+---
 
+### Grafana
 
 ```shell
 helm repo add grafana https://grafana.github.io/helm-charts
@@ -58,6 +65,8 @@ The username for login is `admin`. The password can be acquired by running:
 kubectl get secret -n monitoring grafana -o jsonpath="{.data.admin-password}" | base64 --decode ; echo
 ```
 
+---
+
 #### Configuring Grafana
 
 In the Grafana UI menu, go to `Connections` then `Data sources`. Add your Prometheus service (`http://prometheus-server.monitoring.svc`) as a data source.
@@ -66,6 +75,8 @@ Download the following sample dashboard and Import as a new Dashboard in the Gra
 
 - {{< download "grafana-dashboard.json" "ngf-grafana-dashboard.json" >}}
 
+---
+
 ## Available metrics in NGINX Gateway Fabric
 
 NGINX Gateway Fabric provides a variety of metrics for monitoring and analyzing performance. These metrics are categorized as follows:
@@ -76,6 +87,8 @@ NGINX metrics cover specific NGINX operations such as the total number of accept
 
 These metrics use the `nginx_gateway_fabric` namespace and include the `class` label, indicating the NGINX Gateway class. For example, `nginx_gateway_fabric_connections_accepted{class="nginx"}`.
 
+---
+
 ### NGINX Gateway Fabric metrics
 
 Metrics specific to NGINX Gateway Fabric include:
@@ -88,6 +101,8 @@ Metrics specific to NGINX Gateway Fabric include:
 
 All these metrics are under the `nginx_gateway_fabric` namespace and include a `class` label set to the Gateway class of NGINX Gateway Fabric. For example, `nginx_gateway_fabric_nginx_reloads_total{class="nginx"}`.
 
+---
+
 ### Controller-runtime metrics
 
 Provided by the [controller-runtime](https://github.com/kubernetes-sigs/controller-runtime) library, these metrics include:
@@ -96,6 +111,8 @@ Provided by the [controller-runtime](https://github.com/kubernetes-sigs/controll
 - Go runtime metrics such as the number of Go routines, garbage collection duration, and Go version.
 - Controller-specific metrics, including reconciliation errors per controller, length of the reconcile queue, and reconciliation latency.
 
+---
+
 ## Change the default metrics configuration
 
 You can configure monitoring metrics for NGINX Gateway Fabric using Helm or Manifests.
@@ -104,10 +121,14 @@ You can configure monitoring metrics for NGINX Gateway Fabric using Helm or Mani
 
 If you're setting up NGINX Gateway Fabric with Helm, you can adjust the `metrics.*` parameters to fit your needs. For detailed options and instructions, see the [Helm README](https://github.com/nginx/nginx-gateway-fabric/blob/v1.5.1/charts/nginx-gateway-fabric/README.md).
 
+---
+
 ### Using Kubernetes manifests
 
 For setups using Kubernetes manifests, change the metrics configuration by editing the NGINX Gateway Fabric manifest that you want to deploy. You can find some examples in the [deploy](https://github.com/nginx/nginx-gateway-fabric/tree/v1.5.1/deploy) directory.
 
+---
+
 #### Disabling metrics
 
 If you need to disable metrics:
@@ -149,6 +170,8 @@ To change the default port for metrics:
         <...>
     ```
 
+---
+
 #### Enabling HTTPS for metrics
 
 For enhanced security with HTTPS:

content/ngf/how-to/monitoring/prometheus.md

@@ -1,17 +1,25 @@
 ---
-title: "Tracing"
-weight: 200
+title: Configure tracing
+weight: 100
 toc: true
-docs: "DOCS-000"
+type: how-to
+product: NGF
+docs: DOCS-000
 ---
 
-Learn how to configure tracing in NGINX Gateway Fabric.
+This guide explains how to enable tracing on HTTPRoutes in NGINX Gateway Fabric using the OpenTelemetry Collector. Jaeger is used to process and collect the traces.
+
+---
 
 ## Overview
 
-NGINX Gateway Fabric supports tracing using [OpenTelemetry](https://opentelemetry.io/). The official [NGINX OpenTelemetry Module](https://github.com/nginxinc/nginx-otel) instruments the NGINX data plane to export traces to a configured collector. Tracing data can be used with an OpenTelemetry Protocol (OTLP) exporter, such as the [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector). This collector can then export data to one or more upstream collectors like [Jaeger](https://www.jaegertracing.io/), [DataDog](https://docs.datadoghq.com/tracing/), and many others. This is called the [Agent model](https://opentelemetry.io/docs/collector/deployment/agent/).
+NGINX Gateway Fabric supports tracing using [OpenTelemetry](https://opentelemetry.io/).
+
+The official [NGINX OpenTelemetry Module](https://github.com/nginxinc/nginx-otel) instruments the NGINX data plane to export traces to a configured collector. Tracing data can be used with an OpenTelemetry Protocol (OTLP) exporter, such as the [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector). 
+
+This collector can then export data to one or more upstream collectors like [Jaeger](https://www.jaegertracing.io/), [DataDog](https://docs.datadoghq.com/tracing/), and many others. This is called the [Agent model](https://opentelemetry.io/docs/collector/deployment/agent/).
 
-This guide explains how to enable tracing on HTTPRoutes using NGINX Gateway Fabric. It uses the OpenTelemetry Collector and Jaeger to process and collect the traces.
+---
 
 ## Install the collectors
 
@@ -56,6 +64,8 @@ kubectl port-forward -n tracing svc/jaeger 16686:16686 &
 
 Visit [http://127.0.0.1:16686](http://127.0.0.1:16686) to view the dashboard.
 
+---
+
 ## Enable tracing
 
 To enable tracing, you must configure two resources:
@@ -68,6 +78,8 @@ To enable tracing, you must configure two resources:
 
 For all the possible configuration options for these resources, see the [API reference]({{< ref "/ngf/reference/api.md" >}}).
 
+---
+
 ### Install NGINX Gateway Fabric with global tracing configuration
 
 {{< note >}}Ensure that you [install the Gateway API resources]({{< ref "/ngf/installation/installing-ngf/helm.md#installing-the-gateway-api-resources" >}}).{{< /note >}}
@@ -167,6 +179,8 @@ Save the public IP address and port of NGINX Gateway Fabric into shell variables
 
 You can now create the application, route, and tracing policy.
 
+---
+
 ### Create the application and route
 
 Create the basic **coffee** application:
@@ -261,6 +275,8 @@ URI: /coffee
 
 You shouldn't see any information from the [Jaeger dashboard](http://127.0.0.1:16686) yet: you need to create the `ObservabilityPolicy`.
 
+---
+
 ### Create the ObservabilityPolicy
 
 To enable tracing for the coffee HTTPRoute, create the following policy:
@@ -329,7 +345,9 @@ Select a trace to view the attributes.
 
 The trace includes the attribute from the global NginxProxy resource as well as the attribute from the ObservabilityPolicy.
 
-## Further reading
+---
+
+## See also
 
 - [Custom policies]({{< relref "/ngf/overview/custom-policies.md" >}}): learn about how NGINX Gateway Fabric custom policies work.
 - [API reference]({{< relref "/ngf/reference/api.md" >}}): all configuration fields for the policies mentioned in this guide