From 5b3ac4fa2c728380b883bc4e472f46ae28856438 Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Thu, 25 Jul 2024 11:47:42 +0000 Subject: [PATCH] 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. --- site/config/api/pkg.tpl | 7 +++-- site/content/how-to/_index.md | 7 +---- site/content/how-to/configuration/_index.md | 9 ------ .../control-plane-configuration.md | 7 +++-- site/content/how-to/maintenance/_index.md | 9 ------ site/content/how-to/monitoring/_index.md | 9 ++---- site/content/how-to/monitoring/dashboard.md | 5 ++-- site/content/how-to/monitoring/prometheus.md | 8 ++--- site/content/how-to/monitoring/tracing.md | 4 +-- .../how-to/monitoring/troubleshooting.md | 3 -- .../how-to/traffic-management/_index.md | 9 ++---- .../traffic-management/advanced-routing.md | 29 ++++++++++--------- .../traffic-management/client-settings.md | 5 ++-- .../traffic-management/https-termination.md | 15 ++++++---- .../integrating-cert-manager.md | 13 +++++---- .../redirects-and-rewrites.md | 15 ++++++---- .../traffic-management/response-headers.md | 18 +++++++----- .../routing-traffic-to-your-app.md | 15 +++++----- .../securing-backend-traffic.md | 18 +++++++----- .../upgrade-apps-without-downtime.md | 5 ++-- .../installation/jwt-password-note.md | 2 +- .../expose-nginx-gateway-fabric.md | 3 -- .../installation/installing-ngf/_index.md | 4 +-- .../installation/installing-ngf/helm.md | 7 +++-- .../installation/installing-ngf/manifests.md | 7 +++-- .../ngf-images/building-the-images.md | 4 +-- .../ngf-images/jwt-token-docker-secret.md | 5 ++-- .../ngf-images/pulling-ngf-image.md | 7 ++--- site/content/installation/running-on-kind.md | 11 +++---- site/content/installation/usage-reporting.md | 5 ++-- .../overview/gateway-api-compatibility.md | 3 +- site/content/overview/gateway-architecture.md | 8 +++-- site/content/overview/nginx-plus.md | 2 +- site/content/overview/product-telemetry.md | 5 ++-- site/content/overview/resource-validation.md | 6 ++-- site/content/reference/api.md | 5 ++-- site/content/reference/cli-help.md | 11 ++++--- .../reference/technical-specifications.md | 2 +- 38 files changed, 148 insertions(+), 159 deletions(-) delete mode 100644 site/content/how-to/configuration/_index.md rename site/content/how-to/{configuration => }/control-plane-configuration.md (94%) delete mode 100644 site/content/how-to/maintenance/_index.md rename site/content/how-to/{maintenance => }/upgrade-apps-without-downtime.md (98%) diff --git a/site/config/api/pkg.tpl b/site/config/api/pkg.tpl index 7ca2d3ed5..c5250235f 100644 --- a/site/config/api/pkg.tpl +++ b/site/config/api/pkg.tpl @@ -1,11 +1,14 @@ {{ define "packages" }} --- -title: "API Reference" -description: "NGINX Gateway API Reference" +title: "API reference" weight: 100 toc: false --- +## Overview + +NGINX Gateway API Reference + {{ with .packages}}

Packages: