Skip to content

feat(platform): give Certificate Manager and Custom Pages their own sections and rework Workloads - #2659

Merged
marcus-souza-azion merged 4 commits into
mainfrom
docs/workloads-rework
Nov 18, 2026
Merged

marcus-souza-azion merged 4 commits into
mainfrom
docs/workloads-rework

Conversation

@marcus-souza-azion

@marcus-souza-azion marcus-souza-azion commented Nov 18, 2026 •

Copy link
Copy Markdown
Contributor

What & why

Related issue: none
Pages affected: /en/documentation/platform/certificate-manager/** and /en/documentation/platform/custom-pages/** (new sections, PT /pt-br/documentacao/plataforma/...), /en/documentation/platform/workloads/** (Overview, How it works, Limits, Best practices, Troubleshooting, Glossary, Quickstart, Settings, Attack mitigation, DDoS Protection hub), plus inbound links in about 80 pages across get started, guides, devtools, architectures, use cases, pricing, release notes and both Terms of Service versions.

Certificate Manager and Custom Pages become standalone Platform Resources. They leave Workloads and get their own sections, registered in the root menu right after AI Inference.

  • Existing pages move from /platform/workloads/certificate-manager/ and /platform/workloads/custom-pages/ to /platform/certificate-manager/ and /platform/custom-pages/, keeping their namespaces. Error Responses moves from the Applications reference into Custom Pages.
  • New pages complete each section skeleton: Overview, How it works, Limits with ## Scope, Troubleshooting, Glossary, and a guides hub; Best practices for Certificate Manager only, because no source carries Custom Pages practices.
  • Facts come only from the existing Workloads sections and the moved pages. No fact was dropped: every fact that left a page is on another one.

Workloads is rewritten to the current style guide.

  • The Overview follows the new shape: definition block, list, CTAs, ## Request path, and router.
  • Limits opens with ## Scope.
  • The Certificate Manager and Custom Pages sections and glossary rows leave Workloads. Workloads now names both by their role in the deployment and links their pages.
  • DDoS Protection stays a Feature of Workloads. Its facts moved from the Overview to Attack mitigation, How it works and the glossary.

Links.

  • 193 inbound links now point at the new Certificate Manager and Custom Pages pages, including data files and includes.
  • The Overview no longer has #ddos-protection. 59 links to it now point at Attack mitigation (/workloads/ddos-protection/ddos-mitigation/), Terms of Service included. In both ToS versions, only the URL changed, with legal sign-off.

How I checked it.

  • Each section was reviewed against the azion-docs-writer rules, the findings were applied, and an independent read-only review ran on each section before its fixes.
  • docs_gate.py --check --cross: no P0 on the changed pages.
  • pnpm lint:codeblocks on the 156 changed pages: no issues.
  • npx prettier --check on every changed file: clean.
  • pnpm lint:navcheck: passes. The 50 warnings are the soft row maximum and were already there.
  • pnpm lint:slugcheck: fails on the same 3 pt-br files as on main (ANPD and an old ToS page), and nothing new.
  • I opened every page of the three sections on the local dev server.
  • Not verified: I did not run pnpm build:local. The pages are the source of truth, so no fact was rechecked against the live API or Console.

Open items, not in this PR:

  • src/nav/topnav.json has no entry for the two new trees.
  • The platform-topology diagram still draws Certificate Manager inside the Workload card.
  • The Applications rework PR links the new pages and merges after this one.

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 — every page carries the first five; last_reviewed is on no page in the corpus
  • No legacy "edge-" product names in the copy
  • How-to/tutorial content includes at least one runnable, copy-paste-tested code block — no how-to or tutorial is added; the quickstarts keep their existing code blocks
  • Screenshots (if any) have alt text and follow image standards — no screenshot is added or changed
  • Internal links are relative and resolve locally — including 18 links in Applications pages that this PR rewrites to the new URLs, URL only
  • If any permalink changed or page moved: redirect added in this PR — 10 new redirects and 7 retargeted per language, in apps/docs/redirects/en/01.json and apps/docs/redirects/pt-br/01.json, every old Certificate Manager and Custom Pages URL to its new URL
  • i18n: pt-br updated in this PR or follow-up i18n issue created: every page is changed in both languages
  • I ran pnpm build:local (build + frontmatter check) without errors — not run; the reviewer runs the build

…n sections

Certificate Manager and Custom Pages leave Workloads and become Platform
Resource sections at /platform/certificate-manager/ and
/platform/custom-pages/, with their own nav trees registered after
Workloads in the root menu.

- Move the existing pages to the new permalinks (EN and PT) and retarget
  their internal links; namespaces unchanged.
- Add Overview, How it works, Guides and tutorials, Limits,
  Troubleshooting and Glossary to both sections, and Best practices to
  Certificate Manager, with facts from the current Workloads pages.
- Replace the two root hubs with the Overviews.
- Remove both rows from workloads.json; DDoS Protection stays.
- Redirect every old permalink in redirects/{en,pt-br}/01.json and
  rechain the rows that pointed at the old URLs.
…inbound links

Apply the review findings to every page of both sections, rebuild Error
Responses in the Reference shape, and point inbound links at the new pages.
Links to the retired Workloads DDoS Protection anchor now go to Attack
mitigation, Terms of Service included. Both trees now follow AI Inference
in the root menu.
Rebuild the Overview in the current shape, add Scope to Limits, and remove
the Certificate Manager and Custom Pages sections and glossary rows, which
now live in their own sections. Attack mitigation carries the DDoS
Protection facts the Overview no longer states.
Rewrite the URLs that still pointed at the retired Workloads paths and
anchors for Certificate Manager and Custom Pages, URL only.
@marcus-souza-azion
marcus-souza-azion merged commit e466394 into main Nov 18, 2026
11 checks passed
@marcus-souza-azion
marcus-souza-azion deleted the docs/workloads-rework branch November 18, 2026 00:21
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.

1 participant