Skip to content

docs(templates): migrate the remaining 10 legacy template guides to the current guide pattern (MM-16246) - #2598

Open
bruno-andrade-azion wants to merge 4 commits into
docs/mm-16236-marketplace-template-slugsfrom
docs/mm-16246-migrate-template-guides-part-2
Open

bruno-andrade-azion wants to merge 4 commits into
docs/mm-16236-marketplace-template-slugsfrom
docs/mm-16246-migrate-template-guides-part-2

Conversation

@bruno-andrade-azion

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

Copy link
Copy Markdown
Contributor

Summary

Commits: collections (8 guides), cross-link text, MongoDB Atlas and Azion Starter Kit, and fixes from an independent review.

CI: the CI gate, design-system and internal-links workflows run only on PRs into main, so this stacked PR shows no checks yet. GitHub's retarget to main after #2582 merges is an edited event, which those workflows do not listen to. If #2582 is squash-merged, rebase this branch onto main (dropping #2582's commit) and push; the push starts CI. Otherwise, close and reopen the PR.

How to test

  1. cd apps/docs && pnpm build:local. Expected: the build completes and test:frontmatter passes.
  2. Open a collection guide, for example /en/documentation/guides/application-development/frameworks/astro-ecommerce-collection/ and /pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/frameworks/astro-ecommerce-collection/. Expected: the first step lists one Console link per template (three here), the same URLs as before; two Next steps cards.
  3. Open /en/documentation/guides/application-development/frameworks/mongodb-atlas/ and /en/documentation/guides/application-development/frameworks/azion-starter-kit/ with their pt-br twins. Expected: the Data API caution above Prerequisites; the Bot Manager Lite arguments under Template rules and settings; Set Connector in the default rule.
  4. Optional: pnpm ci:ratchet linkcheck (159 vs baseline 221), pnpm ci:ratchet webkit-adoption (4 vs 56), pnpm ci:ratchet astro-check (31 vs 32) and pnpm ci:ratchet slugcheck (6 vs 6). All pass. ci/baselines.json is not updated, because the lower counts cannot be attributed to this PR.

Locally: pnpm build:local built 2090 pages (2092 on main minus the two Liveness Detection pages #2582 removes) and test:frontmatter passed. rewrite-check.py and linkcheck.py (azion-docs-writer) ran on all 20 files; the only link targets they report as dropped are the external pricing site, https://console.azion.com now written with a trailing slash, and absolute azion.com documentation links now relative.

URL changes and redirects

None. Permalinks, namespaces and file names are unchanged (including gatsby-ecomerce-theme). Every Console Deploy URL is unchanged byte for byte and in the same order.

Notes

Deliberate choices a reviewer may flag:

  • Collection pages list the Deploy URLs as links inside the first step ("Go to the template you want to deploy in Azion Console:"), one per template, because the pattern has one Deploy link inside the first step and these pages have 2 to 5 templates. Their titles name the kind of template ("Deploy an Astro e-commerce template") instead of the collection. The heading is "Deploy a template".
  • Framework versions are kept as they were, including the old pins (Astro 2.0.1, Next.js 13.1.6, min-Hugo 0.62.x, Eleventy 0.5.4, Jekyll Cart 0.1.0, Angular 15.1.2).
  • MongoDB Atlas, pt-br: the old pt-br page had no HTTPS request examples section. It now mirrors en, with the four curl blocks byte-identical to en. Both languages add one line at the top of that section that repeats the caution's retirement date.
  • Azion Starter Kit: the prerequisite "Application Accelerator, Functions, Image Processor, and Network Shield enabled on your account" came only from the old pt-br page; it is now in en too. The <Video> description still says "edge stack", because video tags are kept byte for byte. Next steps links Network Shield instead of Functions, because the template's function is a Firewall function instance.
  • ButterCMS: the Functions card label does not claim the template creates a function, because the old page does not say so.
  • Azion Starter Kit: the Deploy step drops "located in the bottom-right corner", as docs(templates): migrate the legacy template guides to the current guide pattern (MM-16246) #2597 did on dynamic-and-static-file-optimization (directional UI language).
  • Cross-link text: framework-hugo (en and pt-br) quoted the old Hugo title. It is the only page that quoted any of the ten old titles, and docs(templates): migrate the legacy template guides to the current guide pattern (MM-16246) #2597 does not touch it.

SME follow-ups (Marketplace, Tales Viegas), also in MM-16246:

  • MongoDB Atlas Boilerplate: delist the template, or keep it with the caution (review finding 20)? The old page says the storage bucket takes the application name, but its list of created resources names no bucket. Is a bucket created?
  • Azion Starter Kit: is "products enabled on your account" still a prerequisite? Does the deployment still fail with a log when Bot Manager Lite is not installed first?
  • ButterCMS Templates: does each starter project create a function?
  • The community collections pin old framework versions. Should the templates, and then the docs, be updated?

Related issue: MM-16246 (epic MM-16212). Depends on #2582 (MM-16236).

…ection guides to the current guide pattern

Rebuild the five e-commerce collections (Astro, Eleventy, Hugo, Jekyll,
Next.js), the Gatsby E-commerce Theme, and the VuePress and ButterCMS
collections on the How-to skeleton of the first MM-16246 PR. Every
Console Deploy URL stays byte for byte, now listed inside the first
step instead of DocButtons, and every framework version is kept.

Refs MM-16246
…es to the current guide pattern

Keep #2582's Atlas Data API retirement caution and its Bot Manager Lite
wording (the template sets 10/allow; the function defaults are 30/deny).
Rename the Set Origin behavior to Set Connector, rephrase "edge stack"
and "edge computing", translate the leftover English lines in pt-br, and
add the HTTPS request examples the pt-br MongoDB page was missing.

Refs MM-16246
Use "both" for the two-template collections, title the ButterCMS guide
like the other collections, use "projeto inicial" in pt-br, and align
the Azion Starter Kit custom-domain sentence with the other guides.

Refs MM-16246

This branch has not been deployed

No deployments
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