Skip to content

docs(workloads): rework the Workloads section and fold Certificate Manager, Custom Pages and DDoS Protection into it - #2406

Merged
marcus-souza-azion merged 2 commits into
release/new-azion-docsfrom
docs/new-workloads-content
Oct 1, 2026
Merged

marcus-souza-azion merged 2 commits into
release/new-azion-docsfrom
docs/new-workloads-content

Conversation

@marcus-souza-azion

Copy link
Copy Markdown
Contributor

What & why

Workloads is rewritten as the Platform Resource that receives traffic. Its nested Products, Certificate Manager, Custom Pages and DDoS Protection, are folded into it the way Firewall and Applications took theirs in #2405. Before this PR, the section was one settings page filed under an Overview title, plus a 170-word "How to" guide and three nested Products with their own overviews, hubs and duplicated mTLS pages.

  • New Workloads pages:
    • Quickstart: Console, CLI and API.
    • How it works.
    • Settings: every field of a workload and its deployment.
    • Limits: default limits, and included usage per Hobby, Pro and Enterprise plan, linked to the pricing page.
    • Best practices, Troubleshooting and Glossary.
  • Rewritten: the Overview, with a Resources section for each nested Product, and the mTLS reference.
  • Nested Products become dropdowns with a Quickstart and a Reference group:
    • Certificate Manager: a new Quickstart, a new Issuance and renewal page, and Certificates, rewritten. Its URL moves from for-firewall to certificates.
    • Custom Pages: a new Quickstart, and Settings, the old page rewritten and moved to /custom-pages/settings/. Error Responses stays as a v3 row.
    • DDoS Protection: Attack mitigation, rewritten at the same URL.
  • Guides:
    • 11 rewritten as how-to guides, with every Console procedure in a stepper. Old "How to" and title-case titles are replaced; the longest title on the hub is 40 characters.
    • Two duplicate pairs are merged, and the retired guides are listed in src/nav/redirects.json:
      • "How to configure mTLS" into "Configure mTLS on a workload".
      • "How to create a digital certificate" into "Upload a digital certificate".
    • Two guides join the hub: "Configure HTTP and HTTPS ports" and "Customize an error page".
    • Mistagged rows are retagged.
  • Folded pages are deleted, 10 files, 5 per language:
    • the Certificate Manager overview stub and its guides hub
    • the wildcard Let's Encrypt page
    • the duplicate Certificate Manager mTLS page
    • the DDoS Protection overview
  • Facts come from a live run on 2026-10-01 with the API v4 and Azion CLI 4.23.0. It checked status codes, refusal messages, port lists, mTLS enforce and permissive behavior, custom page delivery, and propagation time. One deployment per workload is enforced. A staging workload accepts no custom domain, and wildcard hostnames are refused.
  • Diagrams: the section's 12 Mermaid diagrams run left to right with short labels. A per-diagram sizing line fits them to the frame without horizontal scroll.
  • Across the corpus:
    • Inbound links follow the moved and deleted pages and the renamed headings.
    • Link text that named a retitled guide by its old title now uses the new one.
    • The Let's Encrypt expiration snippet points at Certificates.
  • Coverage, scored against the same frozen question set before and after: 159 of 178 questions answered, up from 105 of 177. 55 gaps closed, 0 opened.

Related issue: MM-16054
Pages affected:

  • Workloads, /documentation/platform/workloads/, and every page under it, including Certificate Manager, Custom Pages and DDoS Protection (EN and PT).
  • The Workloads guides listed on its Guides and tutorials hub.
  • Inbound links across the corpus.
  • src/nav/trees/{workloads,guides}.json, src/nav/redirects.json, src/data/{docs-home,platform-topology}/, src/includes/snippets/LetsEncryptExpiration/, cicd/massive-redirect/.
  • 174 files:
    • 20 pages added and 10 deleted.
    • The Overview moved out of the misspelled worklads/ directory, with no URL change.
    • 131 pages changed (EN and PT), plus 11 code, data and snippet files.

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 legacy "edge-" product names in the copy — legacy names appear only in Console labels and API strings quoted verbatim (such as Production Infrastructure (All Edge Locations)); namespace values keep their edge_ keys, which pair the languages
  • How-to/tutorial content includes at least one runnable, copy-paste-tested code block
  • Screenshots (if any) have alt text and follow image standards — no screenshots added
  • Internal links are relative and resolve locally
  • If any permalink changed or page moved: redirect added in this PR — 9 rows each in cicd/massive-redirect/en.json and pt-br.json, with 7 older rows per language rechained so none lands on a moved or deleted page. The two retired guides are also listed in src/nav/redirects.json
  • i18n: pt-br updated in this PR or follow-up i18n issue created: — updated in this PR
  • [ x I ran pnpm build:local (build + frontmatter check) without errors — not run

…er, Custom Pages and DDoS Protection into it

- New pages, EN and PT: Quickstart, How it works, Settings, Limits (per plan), Best practices,
  Troubleshooting, Glossary; Certificate Manager Quickstart and Issuance and renewal; Custom
  Pages Quickstart.
- Rewritten: Overview (Resources sections for the three nested Products), mTLS, Certificates
  (slug for-firewall -> certificates), Custom page settings (/custom-pages/settings/), Attack
  mitigation.
- Guides: 11 rewritten as how-to guides; 5.14 and 5.15 merged into 5.12 and 5.10 and retired
  in redirects.json; Configure HTTP and HTTPS ports and Customize an error page brought into the
  hub; mistagged rows retagged.
- Nav: Certificate Manager, Custom Pages and DDoS Protection become label-only dropdowns in
  workloads.json; Pricing row points at #workloads.
- Folded and deleted, EN and PT: the Certificate Manager stub and guides hub, the wildcard
  Let's Encrypt page, the Certificate Manager mTLS page, the DDoS Protection overview; 9
  massive-redirect rows per language, 7 older rows rechained.
- Links: corpus, src/data and the LetsEncryptExpiration snippet retargeted to the new
  permalinks and anchors; link text updated to the retitled guides.
…zontal scroll

Shorten every node label to a short phrase (the numbered steps below each
diagram keep the detail) and add a per-diagram sizing line: dagre layout,
13px text, tighter spacing, and useMaxWidth so a diagram wider than its
frame scales down instead of scrolling. EN and PT.
@marcus-souza-azion
marcus-souza-azion merged commit 83d04d7 into release/new-azion-docs Oct 1, 2026
5 of 8 checks passed
@marcus-souza-azion
marcus-souza-azion deleted the docs/new-workloads-content branch October 1, 2026 23:56
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