Docs: Add F5 ADS AWS and Google Cloud - #2300
Open
travisamartin wants to merge 31 commits into
Open
travisamartin wants to merge 31 commits into
travisamartin wants to merge 31 commits into
Conversation
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.
✅ Deploy Preview will be available once build job completes!
|
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
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.
Contributor
Author
|
Note: @travisamartin to port over this PR after it merges: #2303 Cc @defanator This update was made in commit 6d7c94d |
…nx/documentation into f5ads/migrate-aws-and-google
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
marked this pull request as ready for review
September 24, 2026 18:25
Contributor
|
This pull request rebrands the NGINXaaS cloud docs to F5 Application Delivery Service, relocates the AWS and Google Cloud pages under Style findings
Technical accuracy
|
…n-services/google Per IA discussion, moves the public URLs for F5 Application Delivery Service for AWS and Google Cloud from /f5ads/aws/* and /f5ads/google/* to /application-services/aws/* and /application-services/google/*. No content files were moved; this is a front matter metadata change. - Updated url: front matter on all 55 pages under content/f5ads/aws/ and content/f5ads/google/ to the new /application-services/ paths. - Updated canonical: front matter on the 27 content/f5ads/google/ pages that self-reference their own URL for SEO. - Updated canonical: on the 29 legacy content/nginxaas/google/ stub pages (that redirect readers from the old NGINXaaS naming) to point at the new /application-services/google/ URLs, and added a new f5-ref-path field on each preserving the /f5ads/google/ content path, since renamed-notice.html's GetPage lookup resolves by content path, not by public URL. - Updated layouts/shortcodes/renamed-notice.html to validate against f5-ref-path when present, falling back to canonical otherwise, so existing renamed-notice pages outside this change (f5ads/overview, f5ads/changelog) keep working unmodified. - Updated hardcoded titleUrl references in card shortcodes across content/_index.md, content/f5ads/_index.md, content/nginxaas/_index.md, content/f5ads/aws/overview.md, and content/f5ads/google/overview.md, plus two URL entries in data/product-selector.yaml. Note: initially attempted this via a Hugo [permalinks] config rule scoped to the aws/google subsections instead of per-file url: fields, but Hugo's permalinks map only matches top-level section names, so the subsection keys were silently ignored and pages kept resolving at their old URLs. Reverted to explicit per-file url: front matter, which is the same mechanism already in use for every other page in these sections.
thomazdavis
reviewed
Sep 24, 2026
…ogle Five f5ads/google pages and their five nginxaas/google stub counterparts were still delegating to old nginxaas/overview/* and nginxaas/support/ content sources, causing those pages to render renamed-notice content from legacy stub pages instead of the current F5 ADS docs. Update all ten contentSource fields to their f5ads/ equivalents, matching the pattern already in use on the AWS side: - deploy/nginx-configuration/configuration-rules.md - deploy/nginx-configuration/nginx-configuration-console.md - deploy/ssl-tls-certificates/ssl-tls-certificates-console.md - glossary.md (f5ads-glossary.md is the target filename) - support.md
Addresses PR #2300 review comment: five f5ads/google pages still pulled NGINXaaS-branded include fragments, rendering old product/console naming even though the pages themselves were rebranded. - Repoint 9 {{< include >}} references across deploy-console.md, deploy-terraform.md, monitoring/enable-nginx-logs.md, monitoring/metrics-catalog.md, and overview.md from /nginxaas/... to /f5ads/... - Add content/includes/f5ads/google/supported-regions.md and content/includes/f5ads/google/terraform-prerequisites.md, which didn't have f5ads/ equivalents yet, rebranded to F5 ADS for Google Cloud and pointed at current f5ads/google/ pages
Addresses PR #2300 review comment: description, f5-keywords, and f5-summary front matter in three pages still said 'NGINXaaS for Google Cloud' / 'NGINXaaS Console', contradicting the rebranded title and f5-product fields. - deploy-console.md: update f5-keywords and f5-summary - deploy-terraform.md: update description, f5-keywords, and f5-summary; fix a missing space after a comma in f5-keywords; also fix bad punctuation in description (stray comma before 'and' joining only two verbs) - monitoring/metrics-catalog.md: update f5-keywords (also fixes a truncated 'NGINXaaS for Google' missing 'Cloud')
…n-console Addresses PR #2300 review comment: the page title still read 'Create or upload using the NGINXaaS Console', which rendered in the navigation and page heading. Update to 'Create or upload using the Console', matching the AWS sibling page and doc-titles guidance (no product name in the title).
… stubs Addresses PR #2300 review comment: three shared f5ads/overview pages still linked to the legacy /nginxaas/google/ stub pages and used the old 'NGINXaaS for Google Cloud' link text. - about.md: update the Availability list link and text - f5ads-glossary.md: update the Network attachment definition text and the Service Frontend row's Google Cloud link - manage-users-organizations.md: update the Google Cloud prerequisites link and its anchor, which changed after the heading was rebranded to 'Subscribe to the F5 ADS for Google Cloud offering'
…bout.md Addresses PR #2300 review comment: first mention of NGINX Plus was missing the F5 prefix, per f5-product-names (first mention uses the full name with F5 prefix, later mentions drop it). The second mention in the same paragraph already correctly reads 'NGINX Plus'.
Addresses PR #2300 review comment: f5-product-former was 'NGINXaaS for Google Cloud' across all 29 content/nginxaas/google/ stub pages, but the sanctioned former name keeps the F5 prefix, 'F5 NGINXaaS for Google Cloud', matching the pattern already used in content/nginxaas/overview/ and content/nginxaas/changelog.md. This string renders directly in the renamed-notice shortcode's 'This page has moved' callout.
Addresses PR #2300 review comment (thomazdavis): the deploy preview showed 'F5 F5 Application Delivery Service' on both the AWS and Google Cloud pages that delegate content from this shared file. The token is substituted using the calling page's own resolved contentVars, not the delegated source page's. f5ads/aws and f5ads/google both cascade contentVars.product as the full name already including the F5 prefix, so the hardcoded 'F5 ' before in this sentence doubled up. - Remove the redundant hardcoded 'F5 ' from the sentence - Update this page's own contentVars.product from 'ADS' to 'F5 ADS' so the standalone view (/f5ads/overview/...) still reads correctly
Addresses part of the PR #2300 review comment on rebrand leftovers beyond the inline notes. - deploy-console.md (AWS): fix stray prose leftover, 'allow NGINXaaS to accept' -> 'allow F5 ADS to accept' - Migrate Google's static assets to static/f5ads/google/, matching the pattern already used for AWS (copy, keep filenames, don't touch the old nginxaas/google/ copies since the legacy stub page still depends on them): - nginxaas-google-cloud-architecture.svg - css/cost-calculator_v2.css - js/cost-calculator_gc.js - Update the 3 references in f5ads/google/overview.md and f5ads/google/billing/usage-and-cost-estimator.md to point at the new /f5ads/google/ static paths Skips the F5-NGINXaaS-icon.svg logo filename flagged in the same comment: it's the only icon asset that exists for this product family (also used by nginxaas-azure), not a rebrand leftover -- a new asset would need to come from design/brand first.
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
This PR:
content/nginxaas/awstocontent/f5ads/aws(completed in an earlier commit on this branch)content/f5ads/googleand updates them with the new F5 Application Delivery Service for Google Cloud branding and prosecontent/nginxaas/googleandcontent/nginxaas/overviewas live pages with<link rel="canonical">pointing to the F5 ADS equivalents, and adds a{{< renamed-notice >}}callout on every pagelayouts/partials/meta.htmlto emit the canonical tag, andlayouts/_default/list.htmlto render the notice on section landing pages{{< renamed-notice >}}to read canonical front matter instead of the removedf5-moved-tokeyF5 ADS nav updates
Stub page with "This page has moved" shortcode
Canonical links