Skip to content

Commit 5b3ac4f

Browse files
authored
Update documentation for style consistency (#2256)
This commit updates most of the documentation set to adhere to some contemporary documentation style standards: - Sentence case for titles and headings - Initial headings for how-to guides as "Overview" and "Before you begin" - Moving any frontmatter descriptions to the body of text - Removing unnecessary frontmatter data altogether - Removing unnecessary custom style tag (Incorporated into the theme by default) It also collapses a few single document directories (Adding an unnecessary "hop" for users) and re-orders some sections.
1 parent d76d8eb commit 5b3ac4f

38 files changed

+148
-159
lines changed

site/config/api/pkg.tpl

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
{{ define "packages" }}
22
---
3-
title: "API Reference"
4-
description: "NGINX Gateway API Reference"
3+
title: "API reference"
54
weight: 100
65
toc: false
76
---
87

8+
## Overview
9+
10+
NGINX Gateway API Reference
11+
912
{{ with .packages}}
1013
<p>Packages:</p>
1114
<ul>

site/content/how-to/_index.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,4 @@
11
---
2-
title: "How-To Guides"
3-
description:
2+
title: "How-to guides"
43
weight: 300
5-
linkTitle: "Guides"
6-
menu:
7-
docs:
8-
parent: NGINX Gateway Fabric
94
---

site/content/how-to/configuration/_index.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

site/content/how-to/configuration/control-plane-configuration.md renamed to site/content/how-to/control-plane-configuration.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
---
2-
title: "Control Plane Configuration"
3-
description: "Learn how to dynamically update the Gateway Fabric control plane configuration."
4-
weight: 100
2+
title: "Control plane configuration"
3+
weight: 300
54
toc: true
65
docs: "DOCS-1416"
76
---
87

8+
Learn how to dynamically update the Gateway Fabric control plane configuration.
9+
910
## Overview
1011

1112
NGINX Gateway Fabric can dynamically update the control plane configuration without restarting. The control plane configuration is stored in the NginxGateway custom resource, created during the installation of NGINX Gateway Fabric.

site/content/how-to/maintenance/_index.md

Lines changed: 0 additions & 9 deletions
This file was deleted.
Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,4 @@
11
---
2-
title: "Monitoring and Troubleshooting"
3-
description:
4-
weight: 400
5-
linkTitle: "Monitoring and Troubleshooting"
6-
menu:
7-
docs:
8-
parent: How-To Guides
2+
title: "Monitoring and troubleshooting"
3+
weight: 200
94
---

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

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
---
2-
title: "NGINX Plus Dashboard"
3-
description: "Learn how to view the NGINX Plus dashboard to see real-time metrics."
2+
title: "NGINX Plus dashboard"
43
weight: 300
54
toc: true
65
docs: "DOCS-1417"
76
---
87

9-
{{<custom-styles>}}
8+
Learn how to view the NGINX Plus dashboard to see real-time metrics.
109

1110
## Overview
1211

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

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
11
---
2-
title: "Prometheus Metrics"
3-
description: "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."
2+
title: "Prometheus metrics"
43
weight: 100
54
toc: true
65
docs: "DOCS-1418"
76
---
87

9-
{{<custom-styles>}}
8+
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.
109

1110
## Overview
1211

13-
1412
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.
1513

1614
{{<call-out "important" "Security note for metrics">}}
@@ -98,7 +96,7 @@ Provided by the [controller-runtime](https://github.com/kubernetes-sigs/controll
9896
- Go runtime metrics such as the number of Go routines, garbage collection duration, and Go version.
9997
- Controller-specific metrics, including reconciliation errors per controller, length of the reconcile queue, and reconciliation latency.
10098

101-
## How to change the default metrics configuration
99+
## Change the default metrics configuration
102100

103101
You can configure monitoring metrics for NGINX Gateway Fabric using Helm or Manifests.
104102

site/content/how-to/monitoring/tracing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This guide explains how to enable tracing on HTTPRoutes using NGINX Gateway Fabr
1717
Tracing cannot be enabled for [HTTPRoute matches](https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.HTTPRouteMatch) with `headers`, `params`, or `method` matchers defined. It will be added in a future release.
1818
{{< /important >}}
1919

20-
## Install the Collectors
20+
## Install the collectors
2121

2222
The first step is to install the collectors. NGINX Gateway Fabric will be configured to export to the OpenTelemetry Collector, which is configured to export to Jaeger. This model allows the visualization collector (Jaeger) to be swapped with something else, or to add more collectors without needing to reconfigure NGINX Gateway Fabric. It is also possible to configure NGINX Gateway Fabric to export directly to Jaeger.
2323

@@ -333,7 +333,7 @@ Select a trace to view the attributes.
333333

334334
The trace includes the attribute from the global NginxProxy resource as well as the attribute from the ObservabilityPolicy.
335335

336-
## Further Reading
336+
## Further reading
337337

338338
- [Custom policies]({{< relref "overview/custom-policies.md" >}}): learn about how NGINX Gateway Fabric custom policies work.
339339
- [API reference]({{< relref "reference/api.md" >}}): all configuration fields for the policies mentioned in this guide

site/content/how-to/monitoring/troubleshooting.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,8 @@ toc: true
55
docs: "DOCS-1419"
66
---
77

8-
{{< custom-styles >}}
9-
108
This topic describes possible issues when using NGINX Gateway Fabric and general troubleshooting techniques. When possible, suggested workarounds are provided.
119

12-
1310
### General troubleshooting
1411

1512
When investigating a problem or requesting help, there are important data points that can be collected to help understand what issues may exist.

0 commit comments

Comments
 (0)