Repository navigation
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
Conversation
…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
… guide title 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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/mm-16236-marketplace-template-slugs. Merge docs(templates): point Deploy links to the current Marketplace catalog (MM-16236) #2582 first; GitHub then retargets this PR tomain. Second and last PR of MM-16246, after docs(templates): migrate the legacy template guides to the current guide pattern (MM-16246) #2597.## Prerequisites, imperative task sections withDocSteps, the Console link inside the first step (noDocButton),## Next stepswith twoDocCards, the internal Pricing link, and relative links.10/allow; the function defaults are30/deny), and the ButterCMS copy fixes.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 tomainafter #2582 merges is aneditedevent, which those workflows do not listen to. If #2582 is squash-merged, rebase this branch ontomain(dropping #2582's commit) and push; the push starts CI. Otherwise, close and reopen the PR.How to test
cd apps/docs && pnpm build:local. Expected: the build completes andtest:frontmatterpasses./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./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.pnpm ci:ratchet linkcheck(159 vs baseline 221),pnpm ci:ratchet webkit-adoption(4 vs 56),pnpm ci:ratchet astro-check(31 vs 32) andpnpm ci:ratchet slugcheck(6 vs 6). All pass.ci/baselines.jsonis not updated, because the lower counts cannot be attributed to this PR.Locally:
pnpm build:localbuilt 2090 pages (2092 onmainminus the two Liveness Detection pages #2582 removes) andtest:frontmatterpassed.rewrite-check.pyandlinkcheck.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.comnow 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 (includinggatsby-ecomerce-theme). Every Console Deploy URL is unchanged byte for byte and in the same order.Notes
Deliberate choices a reviewer may flag:
curlblocks byte-identical to en. Both languages add one line at the top of that section that repeats the caution's retirement date.<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.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:
Related issue: MM-16246 (epic MM-16212). Depends on #2582 (MM-16236).