Skip to content

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

Open
sankalpsthakur wants to merge 1 commit into
nginx:mainfrom
sankalpsthakur:ngf/f5-metadata-and-titles
Open

docs(ngf): add f5 metadata fields and improve page titles#2184
sankalpsthakur wants to merge 1 commit into
nginx:mainfrom
sankalpsthakur:ngf/f5-metadata-and-titles

Conversation

@sankalpsthakur

Copy link
Copy Markdown

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 APIConfigure additional Gateway listeners with ListenerSet
    • UDPRoute / TCPRouteRoute UDP/TCP traffic with UDPRoute/TCPRoute
    • Rate Limit Policy APIConfigure 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:

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.

Add f5-keywords, f5-description, and f5-summary front matter across
NGINX Gateway Fabric docs so pages work with NGINX Docs search and AI
metadata collection.

Also expand non-descriptive titles (for example ListenerSet API,
UDPRoute, TCPRoute, and *Policy API pages) into clearer task-oriented
titles.

Relates to nginx/nginx-gateway-fabric#5254
@sankalpsthakur
sankalpsthakur requested review from a team as code owners August 1, 2026 09:23
@github-actions github-actions Bot added documentation Improvements or additions to documentation product/ngf Issues related to NGINX Gateway Fabric labels Aug 1, 2026
@github-actions

github-actions Bot commented Aug 1, 2026

Copy link
Copy Markdown

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

@sankalpsthakur

Copy link
Copy Markdown
Author

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

@sankalpsthakur

Copy link
Copy Markdown
Author

recheck

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation product/ngf Issues related to NGINX Gateway Fabric

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update NGF Docs for new f5 metadata and better titles

1 participant