Skip to content

Docs: Add F5 ADS AWS and Google Cloud - #2300

Merged
travisamartin merged 49 commits into
mainfrom
f5ads/migrate-aws-and-google
Sep 28, 2026
Merged

travisamartin merged 49 commits into
mainfrom
f5ads/migrate-aws-and-google

Conversation

@travisamartin

@travisamartin travisamartin commented Sep 18, 2026 •

Copy link
Copy Markdown
Contributor

Proposed changes

This PR:

  • Moves F5 ADS for AWS docs from content/nginxaas/aws to content/f5ads/aws (completed in an earlier commit on this branch)
  • Copies NGINXaaS for Google Cloud docs to content/f5ads/google and updates them with the new F5 Application Delivery Service for Google Cloud branding and prose
  • Preserves content/nginxaas/google and content/nginxaas/overview as live pages with <link rel="canonical"> pointing to the F5 ADS equivalents, and adds a {{< renamed-notice >}} callout on every page
  • Adds canonical front matter support: overrides layouts/partials/meta.html to emit the canonical tag, and layouts/_default/list.html to render the notice on section landing pages
  • Updates {{< renamed-notice >}} to read canonical front matter instead of the removed f5-moved-to key

F5 ADS nav updates

image image

Stub page with "This page has moved" shortcode

image

Canonical links

image

JTorreG and others added 8 commits September 11, 2026 01:05
Introduce F5 Application Delivery Service for Google Cloud as the
canonical product name and location, while keeping the existing
NGINXaaS pages live and pointing search engines at the new tree.

- Copy content/nginxaas/google to content/f5ads/google, updating
  internal Hugo ref paths, url: front matter, and f5-product for the
  new name and location
- Add canonical front matter to all 27 files in both google trees:
  f5ads pages self-declare, nginxaas pages defer to their f5ads
  counterpart
- Add f5-product-former and the renamed-notice shortcode to all 27
  files in content/nginxaas/google and all 15 in
  content/nginxaas/overview
- Add self-referencing canonical to all 15 files in
  content/f5ads/overview
- Override layouts/partials/meta.html to emit the canonical front
  matter key as <link rel="canonical">, falling back to .Permalink
- Override layouts/_default/list.html to render .Content on section
  pages carrying f5-product-former, so the notice appears above the
  card grid on _index.md pages
- Update layouts/shortcodes/renamed-notice.html to read canonical
  instead of the removed f5-moved-to key
- Update the homepage card and product selector to reference the new
  name and f5ads/google URL
- Add F5 Application Delivery Service for Google Cloud to the AGENTS.md
  product names list
Apply the new product naming to body prose across content/f5ads/google.
Front matter is untouched.

- First mention per file uses the full name, F5 Application Delivery
  Service for Google Cloud; subsequent mentions use F5 ADS for Google
  Cloud
- Drop the "(NGINXaaS)" abbreviation introduced at first mention, since
  F5 ADS for Google Cloud is now the short form
- Standalone NGINXaaS becomes F5 Application Delivery Service
- NGINXaaS Console and NGINXaaS console become F5 ADS Console and
  F5 ADS console
- Update link text to match the new naming
- Update the Cloud Monitoring dashboard displayName and the helper
  script comment in fenced code blocks
- Fix a pre-existing truncated product name in
  monitoring/enable-nginx-logs.md, which read "F5 NGINXaaS for Google"

Leaves the `F5 NGINXaaS Service Account Unique ID` UI field name as is,
because the product UI has not been renamed yet. Also leaves lowercase
identifiers and asset paths untouched, such as nginxaas_deployment_name,
$NGINXAAS_SERVICE_ACCOUNT_UNIQUE_ID, and the marketplace URL slug.
Replace the expanded legacy form "NGINX as a Service" with
"F5 Application Delivery Service" in the usage dashboard overview
paragraph, matching the naming applied to the rest of
content/f5ads/google.
@github-actions github-actions Bot added documentation Improvements or additions to documentation tooling Back end, repository, Hugo, and all things not related to content process documentation Documentation related to how the repository or documention itself is managed. labels Sep 18, 2026
@github-actions

Copy link
Copy Markdown

✅ Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/docs/2300/

Bring content/f5ads/google/overview.md into alignment with the
already-edited content/f5ads/aws/overview.md, and add the NGINX Plus
license management note to both files.

- Add missing description, f5-keywords, f5-summary, and f5-audience
  front matter to the Google file, matching the AWS pattern
- Tighten the intro, introduce the "(F5 ADS for Google Cloud)"
  abbreviation on first mention, and shorten to F5 ADS afterward
- Add the NGINX Plus license management sentence to both files
- Turn off isFeaturedSection on the card section and add the missing
  "Get help" card
- Fix the duplicated "operational overhead" capability and rewrite the
  garbled consumption-based pricing bullet
- Convert architecture bullets to active voice, add missing terminal
  punctuation, and align parallel structure with the AWS bullets
- Remove passive "allows client access" phrasing in both frontend
  sections; drop the ad hoc "Access control" subheadings in favor of
  inline treatment matching AWS; split an overlong private endpoint
  paragraph
- Replace self-referencing ref shortcodes with in-page anchors
- Remove "we"/"our" language in Current limitations, add contractions,
  and tighten the constraints intro sentence
- Match the architecture diagram alt text to the F5 ADS short form
- content/f5ads/aws/_index.md: set cascade.contentVars.product to the
  full name, F5 Application Delivery Service for AWS
- content/f5ads/google/_index.md: set title to the full name, F5
  Application Delivery Service for Google Cloud, and add linkTitle:
  F5 ADS for Google Cloud to keep the nav label short
@travisamartin travisamartin self-assigned this Sep 21, 2026
Add documentation/product-rename.md, a playbook for renaming a
product's documentation tree while keeping the old pages live as
stub pages, based on the NGINXaaS for Google Cloud to F5 Application
Delivery Service for Google Cloud rename.

Covers the copy-and-stub pattern only: decisions to make before
starting, the shortcode and layout overrides already in place from
this rename, the steps for building the new tree and updating the
legacy tree, verification checks, and a list of commonly deferred
follow-up work such as includes/static asset migration and legacy
tree body prose.

Reference the new playbook from the Key reference files list in
AGENTS.md.
@travisamartin

travisamartin commented Sep 21, 2026 •

Copy link
Copy Markdown
Contributor Author

Note: @travisamartin to port over this PR after it merges: #2303

Cc @defanator

This update was made in commit 6d7c94d

thomazdavis and others added 4 commits September 21, 2026 15:06
Ports the post-quantum cryptography updates from PR #2303 (merged to
main) onto the f5ads/migrate-aws-and-google branch.

- Add quickstart/_index.md and quickstart/pqc.md under f5ads/aws,
  renamed from NGINXaaS for AWS to F5 Application Delivery Service
  for AWS / F5 ADS for AWS throughout.
- Add quickstart/_index.md and quickstart/pqc.md under f5ads/google,
  renamed from NGINXaaS for Google Cloud to F5 Application Delivery
  Service for Google Cloud / F5 ADS for Google Cloud throughout.
- Add renamed-notice stubs at the old nginxaas/google/quickstart/
  location, following the existing stub pattern (full original body
  preserved, notice injected after front matter).
- Update the SSL/TLS certificate overview pages for both f5ads/aws
  and f5ads/google to list ML-DSA (post-quantum) support and add the
  ML-DSA key-format call-out.
Resolves conflicts from PR #2303 (post-quantum quick-start guides),
which landed on main after this branch had already migrated
nginxaas/aws content to f5ads/aws and renamed nginxaas/google to
f5ads/google.

- content/nginxaas/aws/deploy/ssl-tls-certificates/overview.md and
  content/nginxaas/aws/quickstart/: kept deleted. This branch retires
  the nginxaas/aws path entirely with no redirect stub, consistent
  with the rest of the aws migration.
- content/nginxaas/google/deploy/ssl-tls-certificates/overview.md:
  merged front matter, keeping the stub fields (f5-product-former,
  canonical) added on this branch alongside the SEO field updates
  (f5-docs, f5-keywords, f5-summary, f5-audience) added on main for
  the ML-DSA additions. Body content already carried the ML-DSA
  updates via auto-merge.
- content/nginxaas/google/quickstart/_index.md and pqc.md: kept our
  versions, which already include the renamed-notice stub plus all
  content from main's newly added pages.
@travisamartin
travisamartin marked this pull request as ready for review September 24, 2026 18:25
@travisamartin
travisamartin requested review from a team as code owners September 24, 2026 18:25
F5 ADS for AWS Early Access has ended, so this removes the
nginxaas-early-access@f5.com contact email and its surrounding
Early Access call-out/CTA text (changelog entries are left
untouched as historical record).

Also takes down content/f5ads/aws/deploy/prerequisites.md, whose
only remaining content (subscribe to the AWS Marketplace offering)
now lives inline in deploy-console.md. All links and cards that
pointed to the prerequisites page (in both the f5ads tree and the
mirrored nginxaas stub tree) now point to the deploy-console guide
instead.
content/f5ads/overview/ audit:
- Fix weight collisions by renumbering the section to clean
  increments of 100.
- Retitle vague or wordy pages: "Overview of F5 ADS" -> "F5 ADS
  overview" (title alone renders as "<title> | NGINX Documentation"
  in the browser tab/search result, so it needs to stand on its own
  without relying on the on-page breadcrumb); "About" -> "Key
  capabilities"; "User login" -> "Log in and manage account access";
  "Manage configs using the Console" -> "Manage configurations using
  the Console"; "Programmatic authentication with client
  credentials" -> "Automate API access with client credentials"
  (also applied to the mirrored content/nginxaas stub).
- Add missing one-sentence descriptions to about.md,
  manage-users-organizations.md, user-login.md, and
  f5ads-glossary.md.

WAF enable/disable how-tos (f5ads, nginxaas, nginxaas-azure trees):
- Remove redundant H2 headings that duplicated the page title, and
  drop the unnecessary "Using the Console/Portal" H3 subheading
  where there's only one workflow documented.
- Replace "enable"/"disable" with "turn on"/"turn off" per the
  enable-disable style rule, except where the text must match a
  literal UI button label or an admin toggling a feature at the
  system level (kept in front matter titles/descriptions and in the
  Azure portal button names).
- Fix a trailing-space typo in several WAF page titles.

Nav labels (f5ads app-protect section only):
- Add/update linkTitle values so nav shows shorter labels
  ("Turn on/off F5 WAF protection", "Configure F5 WAF protection",
  "F5 WAF protection" for the section index) while page titles keep
  full "F5 WAF for NGINX" branding.
@github-actions github-actions Bot added the product/nginxaas-azure Issues related to NGINX as a Service for Azure label Sep 25, 2026
Comment thread content/f5ads/aws/deploy/create-deployment/deploy-console.md Outdated
Comment thread documentation/product-rename.md Outdated
@puneetsarna

Copy link
Copy Markdown
Contributor

Thanks Travis & Jon!! This looks good to me:

  • There is a lot in this MR but I am assuming the product content is not changed (except for where we did the rename).
  • https://frontdoor-test-docs.nginx.com/previews/docs/2300/nginxaas: the current preview at the root no longer lists AWS whereas https://docs.nginx.com/nginxaas does list it. not sure if this is expected.
  • I am noticing the new path being used /application-services/google/overview/. Maybe this was settled already, if not the new name is Application Delivery Service.
  • This banner looks good!!
Screenshot 2026-09-25 at 10 06 42 AM
  • Clicking on the new URL from the banner gives me a 404:
Screenshot 2026-09-25 at 10 07 44 AM

Per updated IA direction, moves the public URLs for all F5 ADS docs
(previously split between /f5ads/overview/* and
/application-services/{aws,google}/*) to a single consistent
/app-delivery/* prefix.

This follows the pattern already established in PR #2300 (explicit
url: front matter per file), not a Hugo [permalinks] config entry --
an earlier attempt using a permalinks entry for the f5ads section
had no effect, since every f5ads file already carries an explicit
url: override that takes precedence over the config-driven pattern.

- content/f5ads/**: every file now carries url: and canonical: front
  matter under /app-delivery/*, mirroring its content path (dropping
  the old /f5ads/ and /application-services/ split)
- content/f5ads/_index.md, content/f5ads/aws/overview.md,
  content/f5ads/google/overview.md, content/_index.md: fixed
  hardcoded titleUrl card-shortcode parameters that still pointed at
  the old prefixes (these aren't covered by url:/canonical: front
  matter or {{< ref >}}, so they don't auto-update)
- content/nginxaas/** (45 files): updated canonical: front matter,
  which points at the f5ads pages from the legacy stub tree, to the
  new /app-delivery/* URLs so the "This page has moved" links and
  SEO canonical tags don't go stale
- content/nginxaas/_index.md: fixed the same hardcoded titleUrl issue
  for its "F5 ADS for AWS" card
Refactors content/f5ads/ to use the same URL-generation pattern as
nim/nic: a [permalinks] config entry drives the default URL prefix
for regular leaf pages, and explicit url:/canonical: front matter is
reserved for section index (_index.md) pages only.

Confirmed via a live experiment on nim (temporarily repointed to
/nim-test/) that this hybrid approach works correctly: leaf pages
without an override resolve through the permalinks pattern, while
every section index needs its own explicit url: to avoid a
duplication quirk in Hugo's :sections/:contentbasename tokens.

- config/_default/config.toml: add
  f5ads = '/app-delivery/:sections[1:]/:contentbasename'
- content/f5ads/**/*.md (50 leaf files, excluding _index.md): remove
  url: and canonical: front matter; computed permalinks are
  unchanged, and layouts/partials/meta.html already falls back to
  .Permalink for the canonical tag when the field is absent
- content/f5ads/**/_index.md (22 files): untouched, still carrying
  explicit url:/canonical: overrides

No visible URL changes result from this refactor -- it only reduces
front matter duplication across the tree to match the pattern used
elsewhere in the repo.
@travisamartin

travisamartin commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor Author

Hey @puneetsarna -- Thanks for the review! Here are the answers to your questions:

  • There is a lot in this MR but I am assuming the product content is not changed (except for where we did the rename).

Content changes: The content is the same — the rename required moving docs, fixing links, and updating metadata. I also did copy edits on several topics while I was in them.

NGINXaaS root no longer listing AWS: Expected. The AWS docs moved out of the nginxaas tree entirely and the root moved to the new home: https://frontdoor-test-docs.nginx.com/previews/docs/2300/app-delivery.

We don't need to keep AWS under the old /nginxaas/ root the way we do for Google Cloud. Google Cloud was already GA when the rename happened, so those URLs have to keep working (they're indexed). They stay live as stubs — canonical tag and "This page has moved" banner both pointing at the new /app-delivery/ root. There's no such obligation for AWS — where it sat during EA doesn't bind us. It starts fresh in the new /app-delivery/ root at GA.

  • I am noticing the new path being used /application-services/google/overview/. Maybe this was settled already, if not the new name is Application Delivery Service.

Path using /application-services/: Already addressed — the path was updated to /app-delivery/ in commit c08778e.

404 from the banner link.

404 from the banner link: This is a known preview environment limitation. The "View the current page →" link in the renamed-notice callout strips the /previews/docs/2300 prefix, so it resolves against the CDN root instead of the preview root and 404s. If you add the prefix back manually the page loads fine. This doesn't happen in production or in a local build — only in the preview deploy. No code change needed.

@thomazdavis
thomazdavis self-requested a review September 25, 2026 21:38
travisamartin and others added 11 commits September 25, 2026 22:09
- content/f5ads/aws/billing/overview.md: first mention was the short
  form "F5 ADS for AWS" with no full-name mention anywhere on the
  page (the only body sentence); expand to "F5 Application Delivery
  Service for AWS" per f5-product-names first-mention convention.
- content/f5ads/google/billing/usage-dashboard.md: this Google
  Cloud-specific page used the unqualified "F5 Application Delivery
  Service" name and generic "cloud region(s)" wording; made it
  specific to Google Cloud throughout (full name with cloud
  qualifier and short-form parenthetical on first mention, "Google
  Cloud region(s)" in the filter table and workflow steps). Also
  fixed "NCU (NGINX Compute Units)" to "NGINX Capacity Unit (NCU)",
  matching the term defined everywhere else in the docs.

Audited the rest of content/f5ads/ for the same first-mention issue:
every other aws/ and google/ page already leads with the correctly
cloud-qualified full name before shortening to F5 ADS, and every
include fragment under content/includes/f5ads/ that uses only the
short form is exclusively included from host pages that already
establish the full name earlier on the same page.

Per explicit direction, headings keep the short form regardless of
mention order, since headings surface in the left nav and the full
name takes up more space there.
documentation/product-rename.md was deleted; drop its entry from
the Key reference files list in AGENTS.md.
Full copy edit pass, citing style-guide topics:

- active-voice: 11 passive constructions converted (e.g. "is
  deployed into" -> "deploys into", "are fully managed by F5" ->
  "F5 fully manages")
- tense: 8 future-tense system descriptions -> present tense
- word-list: "utilized" -> use, "via" -> through, "enabling
  customers to" / "allowing customers to" rewritten from the
  reader's perspective
- second-person: "customers" -> "you"
- we-and-our: removed "We recommend..."
- may-can-might: "You may cancel" -> "You can cancel"
- sentence-length: split several 25-30 word sentences
- acronyms: expanded SLA on first use
- numbers: "5 min" -> "5 minutes", "3000" -> "3,000",
  "USD 100" -> "$100" (matches the $ format already in the pricing
  table)
- em-dash: en-dash list separators (Bandwidth, Connections)
  replaced with colons
- headings: "Canceling your F5 ADS for Google Cloud subscription"
  -> "Cancel your subscription" (drops the gerund and the product
  name, which is redundant in a product-scoped doc); the two
  billing-example H3s (one ran 15 words) replaced with short bold
  labels plus a descriptive intro sentence, so the on-page TOC
  isn't cluttered with long headings
- f5-product-names: short form now introduced parenthetically on
  first mention
- admonitions: promoted the data-loss note to a `warning` call-out
  with a title, moved to the top of the Cancel section so readers
  see the risk before the instructions; removed the now-redundant
  sentence restating the same fact lower in the section
- word-list (terminology consistency, ASD-STE100 one-term-per-
  concept): standardized on "cancel"/"cancellation", removing the
  one instance of "unsubscribe" used for the same action
- spelling: "cancelation" -> "cancellation" (American Heritage
  Dictionary main entry; the verb "canceling" was already the
  AHD-preferred single-L form)
- modern-voice: cut marketing filler ("delivering enterprise-grade
  performance, scalability, and security", "ensuring transparent
  and predictable costs", "abstracting operational complexities",
  "to help you explore F5 ADS for Google Cloud and its features")
- Added missing front matter fields (description, f5-keywords,
  f5-summary, f5-audience) to match the AWS billing overview

Reading level improves from roughly grade 14-16 to grade 9-10;
the arithmetic in both billing examples was re-verified and is
correct.

Deliberately NOT included in this commit (waiting on SME
confirmation of pricing tiers for 5 regions that are GA but
unpriced): grouping/alphabetizing the pricing table's region
column, and restoring full-word column headers. The table is left
in its interim shortened-header state.

content/nginxaas/google/billing/overview.md (the legacy stub) is
intentionally untouched.
Backfills the Google Cloud changelog history, splits the combined
legacy changelog into three scoped pages, and renames content/f5ads/
overview to content/f5ads/platform since the folder holds procedures
and reference content, not conceptual overviews.

Changelog restructuring:
- content/f5ads/aws/changelog.md: existing AWS-only changelog,
  cross-linked to the new platform changelog
- content/f5ads/google/changelog.md: new file, backfilled with the
  complete Google Cloud history (14 entries, Sept 2025-Sept 2026)
  from content/nginxaas/changelog.md, rebranded from "NGINXaaS for
  Google Cloud" to "F5 ADS for Google Cloud" and relinked to
  /f5ads/google/* paths
- content/f5ads/platform/changelog.md: new file, for platform-wide
  changes shared across cloud providers (F5 ADS Console, user/org
  management, client credentials) that don't belong to either cloud
  changelog; starts empty, no historical entries qualified
- content/nginxaas/changelog.md: replaced the single-link
  {{< renamed-notice >}} shortcode with a custom call-out linking to
  all three new pages, since the old combined page has no single
  correct successor; canonical set to the Google Cloud changelog
  (better content match: 14 of 18 historical entries were Google
  Cloud-specific) rather than AWS

content/f5ads/overview -> content/f5ads/platform rename (15 files):
- Updated url/canonical front matter in the 4 _index.md files that
  carry explicit overrides
- Fixed internal cross-links between the moved files
- Fixed 2 external {{< ref >}} references, contentSource front
  matter in 12 files, f5-files include metadata in 3 include
  fragments, and 4 hardcoded titleUrl card links in
  content/f5ads/_index.md
- Fixed canonical and f5-ref-path in all 15 content/nginxaas/
  overview/* stub files, which point at this tree
- Retitled the section index from "F5 ADS overview" to "F5 ADS
  platform" to match

Verified with repeated full-repo sweeps for every path format used
in this tree (leading-slash ref paths, contentSource's no-slash
form, hardcoded titleUrl, f5-ref-path) -- zero remaining references
to the old overview path or the old root-level changelog path.
content/f5ads/platform/user-login.md: retitle "Log in and manage
account access" -> "Log in to the Console and manage account
access". This page is about logging into the F5 ADS Console but
never named it; matches the "the Console" short-form pattern
already used by sibling pages in this folder (e.g. "Manage
configurations using the Console").

content/f5ads/google/*: fix 11 instances of "console" that should
read "F5 ADS Console":
- prerequisites.md and deploy/nginx-configuration/configuration-
  rules.md: these said "Google Cloud console" / "F5 ADS for Google
  Cloud console", which is factually wrong, not just a casing slip
  -- traced the linked/included workflow in both cases to confirm
  it's actually the F5 ADS Console (console.nginxaas.net), not
  Google Cloud Console (console.cloud.google.com)
- ssl-tls-certificates-secret-manager.md, monitoring/enable-
  monitoring.md, monitoring/enable-nginx-logs.md: 9 instances of
  lowercase "F5 ADS console" -> "F5 ADS Console", matching the
  capitalized form used 82+ times elsewhere in this tree and the
  capitalization.md rule for official, distinctly-identified product
  names

Verified none of this touched the 13 legitimate "Google Cloud
Console" references in the same files (confirmed via full diff
review) -- Google Cloud Console and F5 ADS Console are both real,
distinct products referenced throughout this tree, and both are
capitalized correctly.
f5-product-names doesn't call for a parenthetical short form after
the full product name -- its own examples show full name, then
short form on subsequent mentions, with no parenthetical ("F5 NGINX
Plus provides... NGINX Plus also supports..."). Parenthetical
introduction is an acronyms.md pattern for technical terms (NCU,
PQC, PSC, SLA, WAF, GC), not product names, and this wasn't applied
consistently across content/f5ads/.

Removed "(F5 ADS)", "(F5 ADS for AWS)", and "(F5 ADS for Google
Cloud)" parentheticals in 10 files where the full name was followed
immediately by its own parenthetical short form. Each file already
uses the short form later (5-47 times), so first-mention order is
unaffected.

Two files needed more than a straight deletion:
- google/billing/usage-dashboard.md: the removed parenthetical was
  the file's only use of the short form, so deleting it left a
  9-word noun cluster ("your F5 Application Delivery Service for
  Google Cloud resource consumption"). Restructured the sentence to
  break up the cluster and shift "the entire customer organization"
  to second person ("your entire organization").
- google/changelog.md: line 195's parenthetical wasn't a first
  mention at all -- the full name already appears two lines above
  (line 193, the GA announcement's opening sentence). Replaced with
  the subsequent short form instead of removing the parenthetical
  outright.

Zero instances existed in content/nginxaas/ (the legacy stub tree),
so nothing there needed changing regardless of scope.
data/product-selector.yaml pointed at the old /f5ads/ and
/application-services/ URL prefixes, both retired earlier in this
branch when F5 ADS public URLs moved to /app-delivery/. Updated all
three entries under "F5 NGINX cloud services" to match:

- F5 Application Delivery Service: f5ads -> app-delivery
- F5 ADS for AWS: application-services/aws/overview/ ->
  app-delivery/aws/overview/
- F5 ADS for Google Cloud: application-services/google/overview/ ->
  app-delivery/google/overview/

Verified against the actual current url: front matter / computed
permalinks for each target page. Checked the rest of data/ and
config/ for the same stale prefixes -- none found.
Glossary consolidation:
- Move content/f5ads/platform/f5ads-glossary.md -> content/f5ads/
  terminology.md (renamed to avoid a URL collision in the product
  selector, since /app-delivery/glossary/ would substring-match the
  separate site-wide "F5 NGINX Glossary" entry under last-match-wins
  matching). title stays "Glossary".
- Delete the two empty-bodied glossary shells under aws/ and google/
  (both inherited via contentSource with no content of their own).
- Repoint the two nginxaas stub glossaries' canonical/f5-ref-path/
  contentSource to the new location.

Support consolidation:
- Bring content/f5ads/support.md front matter up to
  template-how-to.md standard: add description, f5-keywords,
  f5-summary, f5-audience; drop dead contentVars (${product} was
  never used in the body); toc: true -> false (no headings to
  populate it); reorder fields per AGENTS.md.
- Delete the two empty-bodied support shells under aws/ and google/,
  same pattern as the glossary shells.
- Repoint 4 inbound references (two titleUrl/ref links in the aws
  and google overview pages, one in google's NGINX configuration
  rules page) plus the nginxaas google support stub's canonical/
  f5-ref-path.

content/nginxaas/support.md:
- Add {{< renamed-notice >}} with the required canonical,
  f5-product, f5-product-former, and f5-ref-path front matter so the
  "this page has moved" banner renders (it was previously missing
  entirely on this page).

data/product-selector.yaml:
- Broaden the F5 ADS for AWS / Google Cloud entries from matching
  only their overview page (.../aws/overview/) to matching the whole
  subtree (.../aws/), so every page under each cloud shows the
  correct cloud-specific heading in the nav picker, not just the
  overview page.

.gitignore:
- Add /tmp (used for scratch files/screenshots during this session).

Verified with repeated full-repo sweeps across every path format
used in this tree (leading-slash ref paths, contentSource's no-slash
form, hardcoded titleUrl, canonical, f5-ref-path) -- zero remaining
references to any of the deleted or renamed files.
Alphabetize all 15 entries (case-insensitive); the three F5 ADS *
entries were previously grouped mid-table out of order.

Add 3 new entries after auditing the f5ads tree for defined-but-
missing terms:
- NGINX Capacity Unit (NCU): defined as a heading in all 4 overview/
  billing pages (~44 mentions) but absent from the glossary until
  now. Links to the NCU section on both cloud overview pages rather
  than duplicating the per-cloud spec numbers, which could drift.
- F5 ADS Console: the most-used product term in the tree (93
  mentions) and the primary UI, never previously defined.
- Geography: users select one when logging in to the Console, and
  it's a column header in every region/billing table, but the
  existing Geographical controller entry only covered the control
  plane, not the region grouping itself.

Considered and excluded per explicit scope decision (F5 ADS only):
PrivateLink, Private Service Connect, and Workload Identity
Federation -- all third-party cloud provider concepts rather than
F5 ADS ones. Also excluded Client credentials (has its own full
page; narrower audience).

Add 2 cross-reference stubs: Managed public endpoint and Private
endpoint were previously defined only inside the Service frontend
entry, making them unfindable by alphabetical scan under M/P. Each
stub gives a one-line gloss and points to Service frontend for the
full definition, avoiding duplication.

Copy edit, citing style-guide topics:
- sentence-length: split 3 over-length definitions (Service
  frontend's 40-word opener, F5 ADS organization's 37-word sentence,
  VPC endpoint's 33-word sentence)
- NGINX configuration: reframed to define the term instead of
  describing what deployments use
- F5 ADS user: removed the self-referential opener ("F5 ADS users
  have..." restated the term instead of defining it)
- cross-references: Upstream network ended with "see the docs for
  each supported cloud provider" but gave no links; added real
  AWS/Google links matching the pattern already used in Service
  frontend
- possessives: reworded VPC peering's "the network for an F5 ADS
  deployment" construction

Updated f5-keywords and f5-summary to cover the three new terms.

Verified every {{< ref >}} target and anchor resolves (NCU, service
frontend, and upstream network sections on both cloud overview
pages), confirmed the Console URL matches console.nginxaas.net used
elsewhere in the docs, and confirmed the four geographies (US, EU,
APAC, CA) against the supported-regions data.
@travisamartin
travisamartin merged commit d27c3d0 into main Sep 28, 2026
11 checks passed
@travisamartin
travisamartin deleted the f5ads/migrate-aws-and-google branch September 28, 2026 18:36
travisamartin added a commit to nginxinc/nginx-hugo-theme that referenced this pull request Oct 23, 2026
Ports theme changes that were added as local overrides in the
nginx/documentation repo back into the theme as the source of truth:

- Add `layouts/shortcodes/renamed-notice.html`, a shortcode that renders
  a "This page has moved" callout driven by `canonical`, `f5-product`,
  and `f5-product-former` front matter (with an optional `f5-ref-path`
  override for validating page existence when a page's content path
  differs from its public URL).
- `layouts/partials/meta.html`: honour a `canonical` front matter key
  when present, falling back to `.Permalink` otherwise.
- `layouts/_default/list.html`: render `.Content` on section/list pages
  that set `f5-product-former` (even without `f5-landing-page`), so the
  renamed-notice callout shows above the auto-generated card grid.

Replaces the local layout overrides added in:
- nginx/documentation#2287
- nginx/documentation#2300

Verified locally by removing the above overrides from a
nginx/documentation checkout, vendoring this branch via a go.mod
replace directive, and confirming the renamed-notice banner and
canonical <link> tags render correctly on content/nginxaas/google/*.
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 process documentation Documentation related to how the repository or documention itself is managed. product/nginxaas-azure Issues related to NGINX as a Service for Azure tooling Back end, repository, Hugo, and all things not related to content

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants