docs(ngf): add f5 metadata fields and improve page titles

[sankalpsthakur]

Proposed changes

Fixes nginx/nginx-gateway-fabric#5254

NGINX Docs headers now include f5-keywords, f5-description, and f5-summary for search and AI metadata. Most NGF pages were missing these fields, and several titles (for example ListenerSet API, UDPRoute, TCPRoute, Rate Limit Policy API) did not describe the guide outcome.

This PR:

• Adds f5-keywords, f5-description, and f5-summary to all content/ngf/** pages (landing, section indexes, and guides).
• Completes partial front matter on pages that already had only some of these fields.
• Expands non-descriptive titles into clearer, task-oriented titles, including:
  • ListenerSet API → Configure additional Gateway listeners with ListenerSet
  • UDPRoute / TCPRoute → Route UDP/TCP traffic with UDPRoute/TCPRoute
  • Rate Limit Policy API → Configure rate limiting with RateLimitPolicy
  • Similar updates for Client/Proxy/Upstream Settings Policy, Snippets, session persistence, permissions, and related pages

Body content and procedural steps are unchanged; this is front matter / title only.

Checklist

Before sharing this pull request, I completed the following checklist:

• I read the Contributing guidelines
• My branch adheres to the Git conventions
• My content changes adhere to the F5 Technical Writing Style Guide
• If my changes involve potentially sensitive information¹, I have assessed the possible impact
• I have waited to ensure my changes pass tests, and addressed any discovered issues

Validation

• Parsed YAML front matter for all 73 content/ngf Markdown files; each has non-empty f5-keywords, f5-description, and f5-summary.
• Spot-checked title length for newly expanded titles (kept under ~60 characters where practical).
• Docs-only change; no product code changes.

AI/LLM disclosure

• AI coding tools (including Grok and/or Codex agent-assisted editing) were used to help draft or modify code and this PR description.
• I reviewed the complete change, understand the reasoning, and ran the reported local tests before submitting.
• This submission is original work of authorship under the project CLA / contributor terms; AI output was not pasted unreviewed.

Note: F5 CLA may be required for external contributors; happy to complete the CLA bot prompt if it appears on this PR.

Footnotes

1. Potentially sensitive information includes personally identify information (PII), authentication credentials, and live URLs. Refer to the style guide for guidance about placeholder content. ↩

[github-actions]

✅ All required contributors have signed the F5 CLA for this PR. Thank you!
_{Posted by the CLA Assistant Lite bot.}

[sankalpsthakur]

I have hereby read the F5 CLA and agree to its terms

[sankalpsthakur]

recheck

[Copilot]

Pull request overview

This PR standardizes NGF documentation front matter by adding F5 search/AI metadata fields (f5-summary, f5-description, f5-keywords) across content/ngf/**, and updates several page titles to be more outcome-oriented and descriptive.

Changes:

• Add/complete f5-summary, f5-description, and f5-keywords in NGF docs pages (including section indexes and landing pages).
• Expand several non-descriptive titles into clearer, task/outcome-focused titles.
• Keep body/procedural content largely unchanged while improving metadata consistency for search/AI.

Reviewed changes

Copilot reviewed 73 out of 73 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
content/ngf/waf-integration/troubleshooting.md	Add F5 metadata fields for WAF integration troubleshooting page.
content/ngf/waf-integration/policy-sources.md	Add F5 metadata fields for WAF policy source configuration page.
content/ngf/waf-integration/overview.md	Add F5 metadata fields for WAF integration overview page.
content/ngf/waf-integration/get-started.md	Add F5 metadata fields and refine summary for WAF integration quick start.
content/ngf/waf-integration/configuration.md	Add F5 metadata fields for WAF operational configuration page.
content/ngf/waf-integration/_index.md	Add F5 metadata fields for WAF integration section index.
content/ngf/troubleshooting.md	Update title and add F5 metadata fields for general troubleshooting.
content/ngf/traffic-security/secure-backend.md	Add F5 metadata fields for backend mTLS guide.
content/ngf/traffic-security/oidc-authentication.md	Add F5 metadata fields for OIDC authentication guide.
content/ngf/traffic-security/jwt-authentication.md	Add F5 metadata fields for JWT authentication guide.
content/ngf/traffic-security/integrate-cert-manager.md	Add F5 metadata fields for cert-manager integration guide.
content/ngf/traffic-security/cors.md	Add F5 metadata fields for CORS guide.
content/ngf/traffic-security/client-validation.md	Add/adjust F5 metadata fields for client mTLS validation guide.
content/ngf/traffic-security/basic-authentication.md	Add F5 metadata fields for basic auth guide.
content/ngf/traffic-security/_index.md	Add F5 metadata fields for traffic security section index.
content/ngf/traffic-management/upstream-settings.md	Update title and add F5 metadata fields for UpstreamSettingsPolicy guide.
content/ngf/traffic-management/udp-routing.md	Update title and add F5 metadata fields for UDPRoute guide.
content/ngf/traffic-management/tls-passthrough.md	Add F5 metadata fields for TLS passthrough (TLSRoute) guide.
content/ngf/traffic-management/tcp-routing.md	Update title and add F5 metadata fields for TCPRoute guide.
content/ngf/traffic-management/snippets.md	Update title and add F5 metadata fields for snippets guide.
content/ngf/traffic-management/session-persistence.md	Update title and add F5 metadata fields for session persistence guide.
content/ngf/traffic-management/request-response-headers.md	Add F5 metadata fields for request/response header modification guide.
content/ngf/traffic-management/redirects-and-rewrites.md	Add F5 metadata fields for redirects/rewrites guide.
content/ngf/traffic-management/rate-limit.md	Update title and add F5 metadata fields for RateLimitPolicy guide.
content/ngf/traffic-management/proxy-settings.md	Update title and add F5 metadata fields for ProxySettingsPolicy guide.
content/ngf/traffic-management/mirror.md	Add F5 metadata fields for traffic mirroring guide.
content/ngf/traffic-management/listener-sets.md	Update title and refine F5 metadata fields for ListenerSet guide.
content/ngf/traffic-management/https-termination.md	Add F5 metadata fields for HTTPS termination guide.
content/ngf/traffic-management/client-settings.md	Update title and add F5 metadata fields for ClientSettingsPolicy guide.
content/ngf/traffic-management/basic-routing.md	Add F5 metadata fields for basic routing guide.
content/ngf/traffic-management/advanced-routing.md	Add F5 metadata fields for advanced routing guide.
content/ngf/traffic-management/_index.md	Add F5 metadata fields for traffic management section index.
content/ngf/support.md	Update title and add F5 metadata fields for support page.
content/ngf/reference/permissions.md	Update title and add F5 metadata fields for permissions/security context reference.
content/ngf/reference/cli-help.md	Add F5 metadata fields for CLI help reference.
content/ngf/reference/api.md	Add F5 metadata fields for API reference page.
content/ngf/reference/_index.md	Add F5 metadata fields for reference section index.
content/ngf/overview/technical-specifications.md	Add F5 metadata fields for technical specifications reference.
content/ngf/overview/resource-validation.md	Update title and add F5 metadata fields for resource validation reference.
content/ngf/overview/product-telemetry.md	Update title and add F5 metadata fields for telemetry reference.
content/ngf/overview/nginx-plus.md	Add F5 metadata fields for NGINX Plus overview page.
content/ngf/overview/gateway-architecture.md	Add F5 metadata fields for gateway architecture page.
content/ngf/overview/gateway-api-compatibility.md	Add F5 metadata fields for Gateway API compatibility page.
content/ngf/overview/custom-policies.md	Update title and add F5 metadata fields for custom policies page.
content/ngf/overview/_index.md	Add F5 metadata fields for overview section index.
content/ngf/monitoring/tracing.md	Add F5 metadata fields for tracing guide.
content/ngf/monitoring/prometheus.md	Add F5 metadata fields for Prometheus/Grafana monitoring guide.
content/ngf/monitoring/dashboard.md	Add F5 metadata fields for NGINX Plus dashboard monitoring guide.
content/ngf/monitoring/_index.md	Add F5 metadata fields for monitoring section index.
content/ngf/install/upgrade-version.md	Add F5 metadata fields for upgrade guide.
content/ngf/install/secure-certificates.md	Add F5 metadata fields for control/data plane certificate security guide.
content/ngf/install/openshift.md	Add F5 metadata fields for OpenShift installation guide.
content/ngf/install/nginx-plus.md	Add F5 metadata fields for NGINX Plus installation guide.
content/ngf/install/manifests/uninstall.md	Add F5 metadata fields for manifests uninstall guide.
content/ngf/install/manifests/plus.md	Add F5 metadata fields for manifests-based Plus install guide.
content/ngf/install/manifests/plus-experimental.md	Add F5 metadata fields for manifests-based Plus experimental install guide.
content/ngf/install/manifests/open-source.md	Add F5 metadata fields for manifests-based OSS install guide.
content/ngf/install/manifests/open-source-experimental.md	Add F5 metadata fields for manifests-based OSS experimental install guide.
content/ngf/install/manifests/_index.md	Add F5 metadata fields for manifests install section index.
content/ngf/install/ingress-to-gateway.md	Add F5 metadata fields for Ingress-to-Gateway migration guide.
content/ngf/install/helm.md	Add F5 metadata fields for Helm installation guide.
content/ngf/install/deploy-data-plane.md	Add F5 metadata fields for data plane provisioning guide.
content/ngf/install/build-image.md	Add F5 metadata fields for custom image build guide.
content/ngf/install/_index.md	Add F5 metadata fields for install section index.
content/ngf/how-to/upgrade-apps-without-downtime.md	Add F5 metadata fields for zero-downtime upgrade guide.
content/ngf/how-to/scaling.md	Add F5 metadata fields for scaling guide.
content/ngf/how-to/gateway-api-inference-extension.md	Update title and add F5 metadata fields for inference extension guide.
content/ngf/how-to/data-plane-configuration.md	Add F5 metadata fields for data plane configuration guide.
content/ngf/how-to/control-plane-configuration.md	Add F5 metadata fields for control plane configuration guide.
content/ngf/how-to/_index.md	Add F5 metadata fields for how-to section index.
content/ngf/get-started.md	Update title and add F5 metadata fields for NGF quickstart page.
content/ngf/changelog.md	Update title and add F5 metadata fields for changelog page.
content/ngf/_index.md	Add F5 metadata fields for NGF landing page.

[sjberman]

I think we leave this title as it was.

[mjang]

In general, I'm going to reject all title changes in this PR (unless we see a good reason)

• We've set up standardized titles for "reasons".

[sjberman]

This will also have to be updated here: https://github.com/nginx/nginx-gateway-fabric/blob/main/docs/api/pkg.tpl

[mjang]

I'm rejecting all title changes, unless we can show consistency with other F5 templates.

Other reviews forthcoming

[sjberman]

@mjang We opened nginx/nginx-gateway-fabric#5254 (which this PR is attempting to address) to fix the inconsistencies in our docs titles. Do you have suggestions on how we can bring in some consistency and standardize?

[mjang]

I do see a number of redundancies in the proposed titles. Examples:

• Configure rate limiting with RateLimitPolicy
• Configure client settings with ClientSettingsPolicy
• Configure proxy settings with ProxySettingsPolicy
• Configure upstream connections with UpstreamSettingsPolicy

Possible option: replace with titles such as:

• Configure RateLimitPolicy

Disclaimer: we're discussing this internally. so this is subject to change. I'm not sure about including code in titles.

[mjang]

I do see a number of redundancies in the proposed titles. Examples:

Follow-up: I've been told that we will handle title changes internally.

[mjang]

nginx/nginx-gateway-fabric#5254

@sankalpsthakur thank you for your contributions, including in this PR. We understand that the original issue asked for a change in titles. Your PR answered the request directly.

We've made the decision that we'll handle the change of titles internally at F5.

[sankalpsthakur]

Thanks @mjang and @sjberman for the follow-up. Understood titles will be handled internally. I reverted all title edits in 562db32, so current head 7351880 is now metadata only, adding f5-summary/description/keywords across content/ngf (363 additions, 45 deletions, 73 files). No title changes remain.

CLA is signed and disclosure is in the PR body. Happy to keep this open for the metadata part or close if you prefer to handle f5 fields internally as well. Let me know.

Fixes nginx/nginx-gateway-fabric#5254 (metadata part, titles deferred)

[salonichf5]

do we also want to start supporting f5-audience as well while we are changing these

[salonichf5]

Also specify some k8s settings for data plane, we could use one liner here for that too