Skip to content

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

Open
bruno-andrade-azion wants to merge 6 commits into
mainfrom
docs/mm-16246-migrate-legacy-template-guides
Open

bruno-andrade-azion wants to merge 6 commits into
mainfrom
docs/mm-16246-migrate-legacy-template-guides

Conversation

@bruno-andrade-azion

Copy link
Copy Markdown
Contributor

Summary

  • Rebuilds 39 legacy Marketplace template guides, in English and Portuguese, on the How-to skeleton the earlier-migrated template guides use (astro-boilerplate as the structural model, react-boilerplate for the "Key configurations" facts). Each page now has an imperative title, an opening scope sentence, ## Prerequisites, imperative task sections with DocSteps, and ## Next steps with two DocCards. The old Requirements / Deploying / Setting up / Managing boilerplate is gone, and so are "Fill in the presented fields", "You'll be redirected…" and the "Products menu" click path.
  • Terminology and links: the external pricing site is replaced by the internal Pricing page (pt-br: Preços), and absolute https://www.azion.com/en/documentation/... links are now relative. "Set Origin" becomes Set Connector, as the Rules Engine reference names it. "EdgeSQL" becomes SQL Database, the legacy API operation link is replaced, and "edge stack" / "edge latency" / "on the Edge" are gone. In pt-br, "desempenho" is replaced with "performance" and leftover untranslated lines are translated.
  • No fact was dropped: versions, field descriptions, defaults and allowed values, repository links, <Video> embeds, code blocks, and template-specific sections (static-export support, database setup, QStash schedules, rate-limiting behavior) are all kept. The cross-link text on 8 other pages was updated to the new titles.

Scope: the ticket counted ~43 legacy guides. The current count is 49 guides without Next steps; this PR migrates 39 of them. The other 10 are also changed by #2582 (MM-16236, Deploy slugs), so they will be migrated in a follow-up PR after #2582 merges, to avoid a conflict: astro-, eleventy-, hugo-, jekyll- and nextjs-ecommerce-collection, gatsby-ecomerce-theme, vuepress-templates-collection, butter-cms, mongodb-template and azion-starter-kit. This PR does not depend on #2582.

Commits are grouped by template family (framework boilerplates, blogs/CMS, databases and LangGraph, functions and Upstash, cache and optimization, cross-link text), so the review can go one commit at a time.

How to test

  1. cd apps/docs && pnpm build:local. Expected: the build completes (2092 pages) and test:frontmatter passes.
  2. Open any migrated guide, for example /en/documentation/guides/application-development/frameworks/angular-boilerplate/ and its pt-br twin /pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/frameworks/angular-boilerplate/. Expected: the new section order, the Deploy link inside the first step, two Next steps cards, and the internal Pricing link.
  3. Optional: pnpm ci:ratchet linkcheck (161 vs baseline 221), pnpm ci:ratchet webkit-adoption (4 vs 56), pnpm ci:ratchet astro-check (31 vs 32), pnpm ci:ratchet slugcheck (6 vs 6) and pnpm lint:navcheck. All pass. ci/baselines.json is not updated, because the lower counts cannot be attributed to this PR.

URL changes and redirects

None. Permalinks, namespaces and file names are unchanged, and so are the typo'd pt-br names such as neon-databse-with-drizzle and the legacy edge-* slugs. Every Console Deploy URL is unchanged byte for byte.

Notes

Deliberate choices a reviewer may flag:

  • Next steps have two cards, as the docs-writer how-to skeleton requires. The 12 guides migrated earlier still have four and are not touched here.
  • edge-function-starter-kit keeps Products menu > Functions, copied from the migrated edge-ai-starter-kit guide. The Console path convention belongs to MM-16248 (T36).
  • langgraph-template keeps "EdgeSQL Shell", because that is the tool's page title and repository name.
  • wordpress-edgeaccelerator links Cache in Next steps instead of the deprecated Origins page.
  • static-cache has no "Add a custom domain" section, because the old page did not have one.
  • Framework versions are kept as they were. Updating them needs a source this task could not use.

SME follow-ups, also listed in MM-16246:

  • Several templates pin old framework versions (for example React 16.13.1, Astro 2.8.0 and 3.x, Next.js 14.x). Should they be updated in the templates and then in the docs?
  • jekyll-boilerplate requires Ruby 2.5.0 or higher for a Console-only deployment. Is that only for local development?
  • The Cosmic and Sanity templates (and the Docusaurus ones) say the application uses Functions but do not say a function is created. The card labels avoid claiming it.
  • clean-astro-sanity: the field is "Sanity Project ID" in en and "Sanity Studio Project ID" in pt-br. Each was kept from its source; which is the Console label?
  • langgraph-template: the linked EdgeSQL Shell page carries a caution that the tool fails on a clean install. Should the guide keep recommending it?
  • vuepress-boilerplate: the Deploy slug vuepress--boilerplate has a double hyphen, matching the Templates reference. Does it resolve?
  • Out of scope, Templates reference: name mismatches ("Cosmic + …" vs the guide names, "Vuepress Boilerplate"), and Qwik Minimal listed under the wrong category (review finding 29).

Related issue: MM-16246 (epic MM-16212).

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