docs(ngf): add f5 metadata fields and improve page titles - #2184
Open
sankalpsthakur wants to merge 1 commit into
Open
docs(ngf): add f5 metadata fields and improve page titles#2184sankalpsthakur wants to merge 1 commit into
sankalpsthakur wants to merge 1 commit into
Conversation
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
|
✅ All required contributors have signed the F5 CLA for this PR. Thank you! |
Author
|
I have hereby read the F5 CLA and agree to its terms |
Author
|
recheck |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Proposed changes
Fixes nginx/nginx-gateway-fabric#5254
NGINX Docs headers now include
f5-keywords,f5-description, andf5-summaryfor search and AI metadata. Most NGF pages were missing these fields, and several titles (for exampleListenerSet API,UDPRoute,TCPRoute,Rate Limit Policy API) did not describe the guide outcome.This PR:
f5-keywords,f5-description, andf5-summaryto allcontent/ngf/**pages (landing, section indexes, and guides).ListenerSet API→Configure additional Gateway listeners with ListenerSetUDPRoute/TCPRoute→Route UDP/TCP traffic with UDPRoute/TCPRouteRate Limit Policy API→Configure rate limiting with RateLimitPolicyBody content and procedural steps are unchanged; this is front matter / title only.
Checklist
Before sharing this pull request, I completed the following checklist:
Validation
content/ngfMarkdown files; each has non-emptyf5-keywords,f5-description, andf5-summary.AI/LLM disclosure
Note: F5 CLA may be required for external contributors; happy to complete the CLA bot prompt if it appears on this PR.
Footnotes
Potentially sensitive information includes personally identify information (PII), authentication credentials, and live URLs. Refer to the style guide for guidance about placeholder content. ↩