Skip to content

CSTRAT-118: Add renamed-notice shortcode for stub pages- #2286 - #2287

Open
travisamartin wants to merge 3 commits into
mainfrom
add-renamed-notice-shortcode
Open

travisamartin wants to merge 3 commits into
mainfrom
add-renamed-notice-shortcode

Conversation

@travisamartin

Copy link
Copy Markdown
Contributor

What this does

Adds a renamed-notice shortcode that renders a callout on stub pages for renamed products, pointing readers from the old product name to its current documentation. Closes the "build the moved-notice shortcode" subtask under CSTRAT-118.

File

layouts/shortcodes/renamed-notice.html

Usage

Call the shortcode with no arguments in the page body:

{{% renamed-notice %}}

image

All page-specific values come from front matter, not shortcode parameters, so the same call works unchanged on every stub page.

Required front matter

Every page that calls {{% renamed-notice %}} must set three keys:

  • f5-product — the product's current name. This key already exists in the metadata guidelines and is required on every page regardless of this shortcode.
  • f5-product-former — the product's retired name. Not yet an approved key. Added for this shortcode; needs sign-off from whoever owns the metadata schema before this merges as a standing convention rather than a one-off.
  • f5-moved-to — the URL of the page that replaced this one. New key, same approval status as f5-product-former.

If any of the three is missing, or if f5-moved-to doesn't resolve to a real page on the site, the build fails with a specific error naming the offending file. This is intentional: a broken or incomplete stub page fails loudly at build time instead of shipping a blank or misleading notice.

Example front matter:

f5-product: F5 Application Delivery Service for Google Cloud
f5-product-former: NGINXaaS for Google Cloud
f5-moved-to: /f5ads/google-cloud/known-issues/

Open items, not blocking this PR

  • f5-product-former and f5-moved-to need formal approval as metadata keys.
  • Whether the retired product name should carry the "F5" prefix per f5-product-names.md's first-mention rule is unresolved; the style guide's mention rule doesn't clearly cover referencing a former name, so this was left as a judgment call rather than a rule application.
  • Renders below the page H1. An above-the-H1 placement, using the site's existing f5-banner cascade mechanism, was investigated and is technically possible but requires editing a shared theme partial used by every EOL and deprecation banner site-wide. Scoping that as a separate ticket rather than folding it in here.

@travisamartin
travisamartin requested a review from a team as a code owner September 15, 2026 16:43
@github-actions github-actions Bot added the tooling Back end, repository, Hugo, and all things not related to content label Sep 15, 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/2287/

@mjang mjang left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Kewl!

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

Labels

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.

3 participants