Skip to content

docs(store): name the SQL and Storage libraries by their scoped packages - #2575

Merged
bruno-andrade-azion merged 3 commits into
mainfrom
docs/mm-16229-canonical-sql-storage-packages
Nov 12, 2026
Merged

bruno-andrade-azion merged 3 commits into
mainfrom
docs/mm-16229-canonical-sql-storage-packages

Conversation

@bruno-andrade-azion

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

Copy link
Copy Markdown
Contributor

Summary

  • The SQL and Object Storage pages now name the library by its scoped packages, @aziontech/sql and @aziontech/storage, as the Azion Lib reference already does. Before this change, the guides, product pages, and reference pages imported azion/sql and azion/storage and called it "the azion library", which contradicted the Lib reference.
  • Source for the decision: azion@3.1.5, the latest on npm, opens its README with a deprecation notice. The package was migrated to @aziontech/*, receives bug fixes only, and maintenance ends in December 2026. @aziontech/sql@1.0.1 and @aziontech/storage@1.0.0 ship the same API as the azion/sql and azion/storage subpaths (identical type declarations, same build from aziontech/lib).
  • The RESTful tasks API and file upload examples start from a CLI template that doesn't carry the scoped packages, so each gets an npm install step before the code that imports them, followed by the change it makes to package.json.
  • The headings, frontmatter descriptions and meta tags, Mermaid labels, and DocCard labels that still said "the azion library" now name the Azion SQL library or the Azion Storage library, so no page names one package in its headings and imports another in its code. The renamed headings had no inbound anchors.

How to test

  1. pnpm dev
  2. Open /en/documentation/guides/application-development/data/manage-sql-database/ and /pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/dados/gerenciar-bancos-dados-edge-sql/. Prerequisites name the @aziontech/sql package and every import reads from '@aziontech/sql'.
  3. Open /en/documentation/platform/sql-database/glossary/. The first term is @aziontech/sql, linked to the Azion Lib SQL page.
  4. Open /en/documentation/guides/application-development/functions-and-runtime/restful-tasks-api-functions/ and /en/documentation/guides/application-development/functions-and-runtime/file-upload-functions/. Each has an npm install @aziontech/sql or npm install @aziontech/storage step right before the code that imports it.
  5. grep -rnE "azion/(sql|storage)" apps/docs/src/content/docs --include='*.mdx' returns only the Azion Lib pages.

URL changes and redirects

None

Notes

  • Jira: MM-16229 (T17). Epic: MM-16212. This answers question 120 of MM-16194.
  • Left out on purpose:
    • devtools/azion-lib/usage/client.mdx: the Client exists only in the azion package, so its azion/sql type import is correct there.
    • The failure-envelope claims in troubleshooting and create-query keep their wording and only change the package name. Aligning them is MM-16272.
    • azion/kv (Redis compatibility, KV troubleshooting) and defineConfig from azion are separate topics.
  • main was merged into the branch. The SQL Database glossary conflict kept this PR's @aziontech/sql wording with the #create-a-client / #criar-um-client anchors from feat(nav): give every breadcrumb crumb a page and make CLI commands runnable #2636. The vector search guide moved to @aziontech/sql in docs(guides): make the auth layer and vector search tutorials runnable #2566.
  • Checks: all 32 changed MDX files compile with @mdx-js/mdx. docs_gate --check reports 0 findings, and linkcheck.py reports 0 broken links and 0 unpaired namespaces. pnpm build:local was not run. prettier --check and lint:slugcheck fail on main with or without this change, so the results are the same.
  • The code samples were not run against a live account.
  • No permalink changes, no new dependencies in the repo.

Replace azion/sql and azion/storage with @aziontech/sql and
@aziontech/storage across the SQL Database and Object Storage guides,
product pages, references, and the Functions examples, in en and pt-br.
The azion package is deprecated in favor of the scoped packages, and
the Azion Lib reference already documents them.

Refs: MM-16229
* origin/main: (39 commits)
  fix(terminology): replace desempenho and aplicativo in pt-br pages (#2621)
  docs(observe): fix dataset name, Data Stream filter, and Grafana Data path (#2573)
  fix(fundamentals): rewrite the Load Balancer steps in minimize-downtime from the reference (#2578)
  i18n(pt-br): label unlabelled asides and fix label casing (#2622)
  fix(links): point pt-br links to their existing pt-br pages (#2620)
  i18n(pt-br): resync the drifted release notes, punctuation, and Edge Services pairs (#2624)
  i18n(pt-br): pair three pages with their English versions by namespace (#2625)
  docs(style-guide): adopt the jsonl tag for JSON Lines samples (#2642)
  chore(lint): check the changelog entries a PR adds (#2634)
  [NO-ISSUE] ci: replace technote-space/assign-author (SO-5131) (#2591)
  fix(structure): tag bare code fences, fix heading skips, add pt-br meta_tags (#2629)
  docs(style-guide): drop the nonexistent GlossaryFilter from the glossary template (#2577)
  docs(release-notes): fix the October 14 anchor and merge the duplicate February 24 entry (#2572)
  fix(orchestrator): fix broken bind and create-service API samples (#2574)
  docs(readability): split the long sentences in the Runtime, CLI, Reference, and KV Store pages (#2635)
  chore(nav): count only visible rows toward the navcheck soft max (#2640)
  docs(nav): triage the pages outside the navigation (#2593)
  fix(guides): match the QStash variable and the Functions usage response to the code (#2571)
  feat(nav): give every breadcrumb crumb a page and make CLI commands runnable (#2636)
  fix(cli): drop azion update workload-deployment, which the CLI does not expose (#2639)
  ...

# Conflicts:
#	apps/docs/src/content/docs/en/pages/store/sql-database/glossary.mdx
#	apps/docs/src/content/docs/pt-br/pages/store/sql-database/glossario.mdx
…ll outcome

Rename the headings, descriptions, meta tags, Mermaid labels, and DocCard
labels that still called the SQL and Storage libraries "the azion library",
so each page names the package its code imports. State what npm install
changes after each new install step.
@bruno-andrade-azion
bruno-andrade-azion merged commit af6a369 into main Nov 12, 2026
10 checks passed
@bruno-andrade-azion
bruno-andrade-azion deleted the docs/mm-16229-canonical-sql-storage-packages branch November 12, 2026 17:06
bruno-andrade-azion pushed a commit that referenced this pull request Nov 12, 2026
* origin/main: (53 commits)
  docs(style-guide): standardize Azion Console click paths (#2596)
  docs(store): name the SQL and Storage libraries by their scoped packages (#2575)
  fix(terminology): replace desempenho and aplicativo in pt-br pages (#2621)
  docs(observe): fix dataset name, Data Stream filter, and Grafana Data path (#2573)
  fix(fundamentals): rewrite the Load Balancer steps in minimize-downtime from the reference (#2578)
  i18n(pt-br): label unlabelled asides and fix label casing (#2622)
  fix(links): point pt-br links to their existing pt-br pages (#2620)
  i18n(pt-br): resync the drifted release notes, punctuation, and Edge Services pairs (#2624)
  i18n(pt-br): pair three pages with their English versions by namespace (#2625)
  docs(style-guide): adopt the jsonl tag for JSON Lines samples (#2642)
  chore(lint): check the changelog entries a PR adds (#2634)
  [NO-ISSUE] ci: replace technote-space/assign-author (SO-5131) (#2591)
  fix(structure): tag bare code fences, fix heading skips, add pt-br meta_tags (#2629)
  docs(style-guide): drop the nonexistent GlossaryFilter from the glossary template (#2577)
  docs(release-notes): fix the October 14 anchor and merge the duplicate February 24 entry (#2572)
  fix(orchestrator): fix broken bind and create-service API samples (#2574)
  docs(readability): split the long sentences in the Runtime, CLI, Reference, and KV Store pages (#2635)
  chore(nav): count only visible rows toward the navcheck soft max (#2640)
  docs(nav): triage the pages outside the navigation (#2593)
  fix(guides): match the QStash variable and the Functions usage response to the code (#2571)
  ...

# Conflicts:
#	apps/docs/src/content/docs/en/pages/main-menu/reference/accounts/personal-tokens.mdx
#	apps/docs/src/content/docs/en/pages/main-menu/reference/services/support/http-error-status-codes.mdx
#	apps/docs/src/content/docs/pt-br/pages/menu-principal/referencia/contas/personal-tokens.mdx
bruno-andrade-azion pushed a commit that referenced this pull request Nov 12, 2026
* origin/main: (48 commits)
  docs(templates): list the Astro templates that only the showcase covered (#2595)
  docs(orchestrator): consolidate duplicate guides and write How it works (#2588)
  docs(secure): retire the pre-Workloads security journey and guide pages (#2586)
  docs(applications): Run Function needs only Functions; fix WEBP and CORS prerequisites (#2580)
  docs(fundamentals): apply the reader review and the style guide to the Fundamentals pages (#2558)
  fix(observe): name the query editor list instead of its position in the Grafana guides (#2643)
  docs(templates): migrate the legacy template guides to the current guide pattern (#2597)
  docs(style-guide): standardize Azion Console click paths (#2596)
  docs(store): name the SQL and Storage libraries by their scoped packages (#2575)
  fix(terminology): replace desempenho and aplicativo in pt-br pages (#2621)
  docs(observe): fix dataset name, Data Stream filter, and Grafana Data path (#2573)
  fix(fundamentals): rewrite the Load Balancer steps in minimize-downtime from the reference (#2578)
  i18n(pt-br): label unlabelled asides and fix label casing (#2622)
  fix(links): point pt-br links to their existing pt-br pages (#2620)
  i18n(pt-br): resync the drifted release notes, punctuation, and Edge Services pairs (#2624)
  i18n(pt-br): pair three pages with their English versions by namespace (#2625)
  docs(style-guide): adopt the jsonl tag for JSON Lines samples (#2642)
  chore(lint): check the changelog entries a PR adds (#2634)
  [NO-ISSUE] ci: replace technote-space/assign-author (SO-5131) (#2591)
  fix(structure): tag bare code fences, fix heading skips, add pt-br meta_tags (#2629)
  ...

# Conflicts:
#	apps/docs/src/content/docs/en/pages/main-menu/reference/accounts/billing.mdx
#	apps/docs/src/content/docs/en/pages/main-menu/reference/accounts/teams-permissions.mdx
#	apps/docs/src/content/docs/pt-br/pages/menu-principal/referencia/contas/faturamento.mdx
#	apps/docs/src/content/docs/pt-br/pages/menu-principal/referencia/contas/teams-permissions.mdx
bruno-andrade-azion pushed a commit that referenced this pull request Nov 13, 2026
* origin/main: (58 commits)
  docs(workloads): review the Workloads section with the style guide and correct it from live tests (#2570)
  fix(ai-inference): review the AI Inference section and correct it from live tests (#2641)
  docs(templates): apply the review of the migrated template guides (#2645)
  docs(templates): point Deploy links to the current Marketplace catalog (MM-16236) (#2582)
  docs(orchestrator): split how-tos into API v4 and API v3 pages (#2584)
  fix(accounts): hyphenate Real-Time Purge and name the Bills tab in the permissions table (#2581)
  chore(lint): accept the English-only Marketplace Agreement and lower the linkcheck baseline (#2647)
  fix(links): point the v3 Applications reference and the guides at the current pages (#2646)
  docs(runtime): migrate Node.js API samples to the ES Modules handler (MM-16245) (#2592)
  docs(observe): use the current GraphQL dataset names across Observe and guides (#2579)
  docs(templates): list the Astro templates that only the showcase covered (#2595)
  docs(orchestrator): consolidate duplicate guides and write How it works (#2588)
  docs(secure): retire the pre-Workloads security journey and guide pages (#2586)
  docs(applications): Run Function needs only Functions; fix WEBP and CORS prerequisites (#2580)
  docs(fundamentals): apply the reader review and the style guide to the Fundamentals pages (#2558)
  fix(observe): name the query editor list instead of its position in the Grafana guides (#2643)
  docs(templates): migrate the legacy template guides to the current guide pattern (#2597)
  docs(style-guide): standardize Azion Console click paths (#2596)
  docs(store): name the SQL and Storage libraries by their scoped packages (#2575)
  fix(terminology): replace desempenho and aplicativo in pt-br pages (#2621)
  ...
bruno-andrade-azion pushed a commit that referenced this pull request Nov 13, 2026
…nce-soc-pci

* origin/main: (59 commits)
  docs(console): apply the review of the Console path convention (#2644)
  docs(workloads): review the Workloads section with the style guide and correct it from live tests (#2570)
  fix(ai-inference): review the AI Inference section and correct it from live tests (#2641)
  docs(templates): apply the review of the migrated template guides (#2645)
  docs(templates): point Deploy links to the current Marketplace catalog (MM-16236) (#2582)
  docs(orchestrator): split how-tos into API v4 and API v3 pages (#2584)
  fix(accounts): hyphenate Real-Time Purge and name the Bills tab in the permissions table (#2581)
  chore(lint): accept the English-only Marketplace Agreement and lower the linkcheck baseline (#2647)
  fix(links): point the v3 Applications reference and the guides at the current pages (#2646)
  docs(runtime): migrate Node.js API samples to the ES Modules handler (MM-16245) (#2592)
  docs(observe): use the current GraphQL dataset names across Observe and guides (#2579)
  docs(templates): list the Astro templates that only the showcase covered (#2595)
  docs(orchestrator): consolidate duplicate guides and write How it works (#2588)
  docs(secure): retire the pre-Workloads security journey and guide pages (#2586)
  docs(applications): Run Function needs only Functions; fix WEBP and CORS prerequisites (#2580)
  docs(fundamentals): apply the reader review and the style guide to the Fundamentals pages (#2558)
  fix(observe): name the query editor list instead of its position in the Grafana guides (#2643)
  docs(templates): migrate the legacy template guides to the current guide pattern (#2597)
  docs(style-guide): standardize Azion Console click paths (#2596)
  docs(store): name the SQL and Storage libraries by their scoped packages (#2575)
  ...

# Conflicts:
#	apps/docs/src/content/docs/en/pages/main-menu/compliance/pci-dss.mdx
#	apps/docs/src/content/docs/en/pages/main-menu/compliance/soc-2.mdx
#	apps/docs/src/content/docs/pt-br/pages/menu-principal/compliance/pci-dss.mdx
#	apps/docs/src/content/docs/pt-br/pages/menu-principal/compliance/soc.mdx
bruno-andrade-azion pushed a commit that referenced this pull request Nov 13, 2026
* origin/main: (59 commits)
  docs(console): apply the review of the Console path convention (#2644)
  docs(workloads): review the Workloads section with the style guide and correct it from live tests (#2570)
  fix(ai-inference): review the AI Inference section and correct it from live tests (#2641)
  docs(templates): apply the review of the migrated template guides (#2645)
  docs(templates): point Deploy links to the current Marketplace catalog (MM-16236) (#2582)
  docs(orchestrator): split how-tos into API v4 and API v3 pages (#2584)
  fix(accounts): hyphenate Real-Time Purge and name the Bills tab in the permissions table (#2581)
  chore(lint): accept the English-only Marketplace Agreement and lower the linkcheck baseline (#2647)
  fix(links): point the v3 Applications reference and the guides at the current pages (#2646)
  docs(runtime): migrate Node.js API samples to the ES Modules handler (MM-16245) (#2592)
  docs(observe): use the current GraphQL dataset names across Observe and guides (#2579)
  docs(templates): list the Astro templates that only the showcase covered (#2595)
  docs(orchestrator): consolidate duplicate guides and write How it works (#2588)
  docs(secure): retire the pre-Workloads security journey and guide pages (#2586)
  docs(applications): Run Function needs only Functions; fix WEBP and CORS prerequisites (#2580)
  docs(fundamentals): apply the reader review and the style guide to the Fundamentals pages (#2558)
  fix(observe): name the query editor list instead of its position in the Grafana guides (#2643)
  docs(templates): migrate the legacy template guides to the current guide pattern (#2597)
  docs(style-guide): standardize Azion Console click paths (#2596)
  docs(store): name the SQL and Storage libraries by their scoped packages (#2575)
  ...

# Conflicts:
#	apps/docs/redirects/en/01.json
#	apps/docs/redirects/pt-br/01.json
#	apps/docs/src/content/docs/en/homes/architctures/by-use-case/application-and-network-security.mdx
#	apps/docs/src/content/docs/pt-br/homes/arquiteturas/por-solucao/seguranca-de-aplicacoes-e-redes.mdx
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