Skip to content

docs(firewall): retire the WAF and Bot Manager examples hubs - #2656

Merged
bruno-andrade-azion merged 1 commit into
mainfrom
docs/retire-firewall-examples-hubs
Nov 17, 2026
Merged

bruno-andrade-azion merged 1 commit into
mainfrom
docs/retire-firewall-examples-hubs

Conversation

@bruno-andrade-azion

@bruno-andrade-azion bruno-andrade-azion commented Nov 17, 2026 •

Copy link
Copy Markdown
Contributor

What & why

Related issue: MM-16268
Pages affected: /en/documentation/secure/waf/examples/, /en/documentation/secure/bot-manager/examples/, /pt-br/documentacao/secure/waf/exemplos/, /pt-br/documentacao/secure/bot-manager/exemplos/ (all four removed)

Retires the WAF and Bot Manager examples hubs instead of moving them. The ticket asked to move the two hubs from /documentation/secure/... to /documentation/platform/firewall/... and register them in firewall.json. The Information architecture page rules that target out: the Examples slot is for Functions only, and a worked configuration for any other Platform Resource is a how-to guide in the Guides catalog, listed by the resource's Guides and tutorials hub. A nested Product such as WAF or Bot Manager has no Examples row of its own either. The 12 example pages behind the two hubs already are how-to guides: they are how-to-guide rows in src/nav/trees/guides.json, and the Firewall guides and tutorials hub lists them. Registering the hubs would add a second list of a subset of those rows, in a slot the style guide does not allow.

Navigation and redirects. #2593 parked both hubs in src/nav/redirects.json as discarded, pointing at the Firewall guides and tutorials hub, and left the two entries for this ticket. This PR deletes the four page files, removes the two entries, and adds the four 301s that pnpm nav:url-map generated from them. No other page links to the old URLs, and no existing redirect points at them, so there is no chain to retarget.

Out of scope. The 12 child files still sit under secure/{waf,bot-manager}/examples/ (exemplos/) while their permalinks are under /documentation/guides/application-security/.... The path does not decide the URL, so the files stay where they are. The six /documentation/products/secure/ journey pages from the same review finding are not in this ticket.

How I checked it.

  • pnpm lint:navcheck: passes, 0 discarded, 3 exempt, no orphans.
  • pnpm lint:slugcheck: the 3 known failures of the single-language legal pages, the same as main.
  • pnpm lint:links: no finding on the changed paths.
  • The azion-docs-writer skill's linkcheck.py over the 926 secure, guides, and hubs pages: 0 broken links, 0 unpaired namespaces.
  • git grep for the four old URLs and the two namespaces: no remaining references outside the redirect files.
  • pnpm build:local (Node 26): 2162 pages built, the frontmatter check passed. In dist, the four old URLs are gone, and both Firewall guides and tutorials hubs list all 12 former example guides.
  • Not verified: the redirects in production. They take effect after deploy.

Type of change

  • 🆕 New content (feat)
  • 🩹 Fix (fix) — typo, broken link, wrong information
  • ♻️ Content update (docs) — rewrite, expansion, upkeep
  • 🌐 Translation sync (i18n)
  • 🏗️ Platform / structure (refactor / chore) — reviewed by UXE, no content mixed in

Author checklist

  • PR title follows type(scope): summary (see GOVERNANCE.md §4)
  • Frontmatter complete: title, description, meta_tags, namespace, permalink, last_reviewed — no page is added or edited, only removed
  • No legacy "edge-" product names in the copy — no copy is added
  • How-to/tutorial content includes at least one runnable, copy-paste-tested code block — no how-to or tutorial is added or changed
  • Screenshots (if any) have alt text and follow image standards — no screenshot is added or changed
  • Internal links are relative and resolve locally
  • If any permalink changed or page moved: redirect added in this PR
    • /en/documentation/secure/waf/examples/ -> /en/documentation/platform/firewall/guides/ (apps/docs/redirects/en/01.json)
    • /en/documentation/secure/bot-manager/examples/ -> /en/documentation/platform/firewall/guides/ (apps/docs/redirects/en/01.json)
    • /pt-br/documentacao/secure/waf/exemplos/ -> /pt-br/documentacao/plataforma/firewall/guias/ (apps/docs/redirects/pt-br/01.json)
    • /pt-br/documentacao/secure/bot-manager/exemplos/ -> /pt-br/documentacao/plataforma/firewall/guias/ (apps/docs/redirects/pt-br/01.json)
  • i18n: pt-br updated in this PR or follow-up i18n issue created: — both pt-br hubs are removed and redirected in this PR
  • I ran pnpm build:local (build + frontmatter check) without errors

The Examples slot is for Functions only; the 12 examples are already
how-to guides listed by the Firewall guides and tutorials hub. Remove
the en and pt-br hubs, their discarded entries in src/nav/redirects.json,
and redirect the four URLs to the Firewall guides hub.

Co-Authored-By: Claude <[email protected]>
@bruno-andrade-azion
bruno-andrade-azion requested a review from a team November 17, 2026 15:05
@bruno-andrade-azion
bruno-andrade-azion merged commit 5ef4155 into main Nov 17, 2026
11 checks passed
@bruno-andrade-azion
bruno-andrade-azion deleted the docs/retire-firewall-examples-hubs branch November 17, 2026 17:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants