Repository navigation
docs: Add missing description front matter in f5ads docs - #2425
Open
travisamartin wants to merge 2 commits into
Open
travisamartin wants to merge 2 commits into
travisamartin wants to merge 2 commits into
Conversation
This commit adds the required description metadata field to 37 pages under content/f5ads that were missing it, including section _index.md pages. Descriptions are one sentence, under 160 characters, and reflect each page's or section's actual content. Covers the AWS, Google Cloud, and platform (shared) subtrees: - Section landing pages (deploy, billing, monitoring, quickstart, nginx-configuration, ssl-tls-certificates, app-protect) - Changelogs and known-issues reference pages - How-to and concept pages (cost estimator, usage dashboard, access management, enable monitoring, enable NGINX logs, console guides) No other front matter fields or body content were changed.
github-actions
Bot
added
the
documentation
mjang
approved these changes
Oct 22, 2026
mjang
left a comment
mjang
left a comment
Contributor
There was a problem hiding this comment.
Ding! Lesson learned: treat the description field (almost) like UI text
✅ Deploy Preview will be available once build job completes!
|
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
2 participants
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.
What changed
Adds the required
descriptionfront matter field to 37 pages undercontent/f5adsthat were missing it, including section_index.mdpages.
descriptionis a required metadata field (used for search,SEO, and content indexing) per the F5 metadata reference, so these
pages were non-compliant.
No other front matter fields or body content were changed.
Scope
Covers the AWS, Google Cloud, and shared platform subtrees:
nginx-configuration, ssl-tls-certificates, app-protect
management, enable monitoring, enable NGINX logs, console guides
37 files changed, all additions (no deletions or body edits).
Approach
quotes, matching existing repo conventions (e.g.
platform/_index.md,aws/billing/overview.md).SSL certificate consoles, NGINX configuration rules), descriptions
were adapted from the sibling page's existing description, swapping
the product/cloud name.
directory to make sure the description reflects everything in the
section (for example, noting that Google deployments can be created
via Terraform in addition to the Console, and that monitoring
sections also include a metrics catalog).
How to review
description:line per file.accuracy.
make lint-markdownwasn't runnable in this environment (no Hugo/Docker available), so please run it locally or in CI before merge.
Before
After