Skip to content

docs(connectors): rework the Connectors section and fold Load Balancer, Origin Shield and Live Ingest into it - #2407

Merged
marcus-souza-azion merged 1 commit into
release/new-azion-docsfrom
docs/new-connectors-docs
Oct 2, 2026
Merged

marcus-souza-azion merged 1 commit into
release/new-azion-docsfrom
docs/new-connectors-docs

Conversation

@marcus-souza-azion

Copy link
Copy Markdown
Contributor

What & why

Connectors is rewritten as the Platform Resource that takes an application's requests to an origin. Its nested Products, Load Balancer, Origin Shield and Live Ingest, are folded into it the way Firewall, Applications and Workloads took theirs in #2405 and #2406. Before this PR, the section was an Overview that was really a settings page, two Product pages with their own layouts, and a guides hub of its own for Load Balancer. It had no Quickstart, How it works, Limits, Best practices, Troubleshooting or Glossary, and no guide was tagged to it.

  • New Connectors pages:
    • Quickstart: Console, CLI and API.
    • How it works.
    • Connector settings: every field of a connector, by type, with the errors the API returns.
    • Limits: bounds per connector and per Product, and included usage per Hobby, Pro and Enterprise plan, linked to the pricing page.
    • Best practices, Troubleshooting and Glossary.
    • A Guides and tutorials hub.
  • Rewritten: the Overview, with a Resources section for each nested Product.
  • Nested Products become dropdowns with a Reference group:
    • Load Balancer: a new Quickstart, and Balancing methods, the old Load Balancer page rewritten. Its URL moves to /load-balancer/balancing-methods/.
    • Origin Shield: Origin IP ACL and HMAC, the old Origin Shield page rewritten. Its URL moves to /origin-shield/origin-ip-acl-and-hmac/.
    • Live Ingest: a new Ingestion and delivery page. Live Ingest had no documentation page before.
  • SNI Check keeps its URL. Its two "How to" sections move to Troubleshooting.
  • Guides:
    • Two new how-to guides, tabbed for Console, CLI and API, with every Console procedure in a stepper: "Sign origin requests with HMAC" and "Set the Host header and path prefix for an origin".
    • Five existing guides join the hub. Their links follow the new pages, and three sentences that contradicted the live run are corrected.
    • The DNS load-balancing guide is retagged to Edge DNS.
  • Folded pages are deleted, 4 files, 2 per language:
    • the Load Balancer guides hub
    • the Live Ingest best-practices guide, whose practices move to Best practices
  • Facts come from a live run on 2026-10-01 and 2026-10-02 with the API v4 and Azion CLI 4.23.0. It checked status codes and refusal messages for every field, Host header and path prefix behavior through a workload, Load Balancer distribution and inactive addresses, and HMAC signing against a private bucket. Corrections it forced:
    • Up to 15 addresses with Load Balancer, not 10.
    • Timeouts and retries exist only with Load Balancer on.
    • HMAC is configured inside Origin Shield.
    • A Live Ingest connector requires a region.
    • An unsigned request to the storage endpoint gets 401, not 403.
  • Diagrams: the section's Mermaid diagrams run left to right with short labels and the sizing line, with no horizontal scroll at desktop or phone width.
  • Across the corpus:
    • Inbound links follow the moved and deleted pages: 171 links. Each one goes to the Product's Overview section or to its mechanism page, depending on what the link points at.
    • Links to the old Overview anchors (#http, #object-storage, #protocol-policy) point at Connector settings.
    • The platform topology and use-case data files, and the pricing page's two buttons, point at the new URLs.
  • Coverage, scored against the same frozen question set before and after: 139 of 165 questions answered, up from 85 of 165. 54 gaps closed, 0 opened, 0 regressed.

Related issue: MM-16056
Pages affected:

  • Connectors, /documentation/platform/connectors/, and every page under it, including Load Balancer, Origin Shield and Live Ingest (EN and PT).
  • The Connectors guides listed on its Guides and tutorials hub.
  • Inbound links across the corpus.
  • src/nav/trees/{connectors,guides}.json, src/data/{platform-topology,use-cases}/, cicd/massive-redirect/.
  • 97 files:
    • 24 pages added and 4 deleted.
    • 61 pages changed (EN and PT), plus 8 nav, data and redirect 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 API strings quoted verbatim (the EdgeApplicationRuleEngine reference inside a delete refusal); namespace values keep their edge_ keys, which pair the languages, and the edge-connector/ directory keeps its path
  • How-to/tutorial content includes at least one runnable, copy-paste-tested code block — both new guides and both quickstarts carry CLI and API commands from the live run. The HMAC guide's CLI body was not sent through the CLI; the same body was sent through the API
  • 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
  • i18n: pt-br updated in this PR or follow-up i18n
  • I ran pnpm build:local (build + frontmatter check) without errors — not run

…r, Origin Shield and Live Ingest into it

Rebuild /documentation/platform/connectors/ (EN and PT) on the thirteen-slot
skeleton the Workloads, Firewall and Applications sections use.

- New pages: Quickstart (Console, CLI, API), How it works, Connector settings,
  Limits (per plan from the pricing page), Best practices, Troubleshooting,
  Glossary, and a Connectors guides hub.
- Load Balancer, Origin Shield and Live Ingest become dropdowns. The Load
  Balancer page becomes Balancing methods (+ a Load Balancer quickstart), the
  Origin Shield page becomes Origin IP ACL and HMAC, and Live Ingest gets an
  Ingestion and delivery page.
- Overview rewritten as a decision page; SNI Check keeps its URL, with its
  diagnosis steps moved to Troubleshooting.
- Two new how-to guides: Sign origin requests with HMAC, and Set the Host
  header and path prefix for an origin.
- Guides: five existing guides retargeted and tagged into the hub; DNS load
  balancing retagged to Edge DNS; the Load Balancer guides hub and the Live
  Ingest best-practices guide folded and removed.
- Facts corrected from a live API and CLI run: up to 15 addresses with Load
  Balancer, timeouts and retries only under Load Balancer, HMAC configured in
  Origin Shield, `region` required for `live_ingest`, `202` on writes.
- Redirects: rows for the moved and folded URLs, older chains rechained, and
  the missing rows for the 2026-09-09 /products/secure/connectors/* move.
- Inbound links across the corpus and src/data retargeted to the new URLs and
  anchors.
@marcus-souza-azion
marcus-souza-azion merged commit d0d4cc2 into release/new-azion-docs Oct 2, 2026
5 of 8 checks passed
@marcus-souza-azion
marcus-souza-azion deleted the docs/new-connectors-docs branch October 2, 2026 03:22
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