CSTRAT-118: Add renamed-notice shortcode for stub pages- #2286 - #2287
Open
travisamartin wants to merge 3 commits into
Open
travisamartin wants to merge 3 commits into
travisamartin wants to merge 3 commits into
Conversation
✅ Deploy Preview will be available once build job completes!
|
JTorreG
approved these changes
Sep 16, 2026
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.
What this does
Adds a
renamed-noticeshortcode 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.htmlUsage
Call the shortcode with no arguments in the page body:
{{% renamed-notice %}}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 asf5-product-former.If any of the three is missing, or if
f5-moved-todoesn'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:
Open items, not blocking this PR
f5-product-formerandf5-moved-toneed formal approval as metadata keys.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.f5-bannercascade 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.