Repository navigation
docs(migration): share the repeated migration-guide procedures as partials - #2619
Open
bruno-andrade-azion wants to merge 1 commit into
Open
bruno-andrade-azion wants to merge 1 commit into
bruno-andrade-azion wants to merge 1 commit into
Conversation
…tials
Move the Console, CLI, and API panels that the five provider migration
guides repeated into heading-free partials under
src/includes/migration-guides/{en,pt-br}, reconciling the versions that
had drifted. Replace the retired module classification in the mapping
tables, link LoRA Fine-Tune to its docs page, and align the Workload
steps of Migrate to Azion with the Workloads quickstart.
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.
What & why
Related issue: MM-16251
Pages affected: the five provider migration guides, in
apps/docs/src/content/docs/en/pages/guides/*-to-azion/andapps/docs/src/content/docs/pt-br/pages/guias/*-to-azion/, plus/en/documentation/fundamentals/migrate-to-azion/and/pt-br/documentacao/fundamentos/migrar-para-a-azion/Shared procedures move into partials. The five migration guides repeated the same Azion procedures, about 2,600 lines in each language. The repeated panels had already drifted apart: 3 to 5 versions of each panel, with facts that only some guides carried. The Console, CLI, and API panels of ten sections now come from 32 heading-free partials per language, in
apps/docs/src/includes/migration-guides/{en,pt-br}/. The sections are environment variables, redirects, cache, Load Balancer, Image Processor, WAF, rate limits, Data Stream, the certificate, and Edge DNS. The Bot Manager Lite procedure and the rate limit with penalty are partials too.rehype-slugrestarts its count in every MDX file, andrehype-tab-panel-headingsbuilds the?interface=…#sectionanchor from headings in the same file. So each partial holds a panel body only, and the##/###/####headings, the<Tabs>, the introductions, and the comparison tables of each provider stay where they were. The table of contents, the heading ids, and the panel anchors are unchanged."active"per Load Balancer address,engine_settingsin the WAF body, the secondcurlof the bot check, the weighted DNS record,Create Custom Templatein Data Stream, and the Bot Manager Lite template link. Where two versions disagreed, the reference page decided.The API refuses learning as a modestays, because the Firewall Rules Engine reference listslearningunder error10039. The Image Processor CLI panel now shows theazion update application --image-processor truecommand from the Image Processor quickstart, instead of only pointing to it. Example values are neutral (My WAF,/old/→/new/,static-assets). One guide's redirect check now requests/old/post, to match the shared rule.Smaller fixes, in both languages.
live_ingest". WAF is "applied to a firewall". The shared panels also drop "the Functions module" and "the WAF module". The**Modules**click paths and the Network Shield sentences are not touched.pt-brrow now links to thept-brpage.How I checked it
mdxToMarkdownfromorigin/mainand from this branch, and compared the two. The only differences are the reconciliations and fixes above. The partials are inlined, and no component, import, or JSX comment reaches the.md.pnpm exec tsx scripts/check-markdown-twin.tson the 12 pages: no MDX left in any Markdown twin.linkcheck.py) over the 12 pages and the 64 partials found 0 broken links, 0 broken taught URLs, 0 cross-language links, and every namespace paired.docs_gate.py --check) gives the same counts before and after on every guide. Its only finding on the partials is "no frontmatter", which does not apply to an include.pnpm lint:links, which is warn-only, still reports that each guide has no closing link into "applications" beyond its overview. That warning is the same onorigin/mainand is not part of this change.pnpm build:localbuilt 2,092 pages, and the frontmatter check passed. In the built HTML of one guide, in both languages, the 65 headings of the source render as 65 unique ids, so no id repeats and the table of contents is unchanged. The panel anchors still carry the section (?interface=api#data-stream), and the text from the partials renders on all 10 guide pages.Type of change
feat)fix) — typo, broken link, wrong information — the Workload form steps, the LoRA link, and the retired module wordingdocs) — rewrite, expansion, upkeepi18n)refactor/chore) — reviewed by UXE, no content mixed inAuthor checklist
type(scope): summary(see GOVERNANCE.md §4)title,description,meta_tags,namespace,permalink,last_reviewed— frontmatter is unchanged; none of the 12 pages carrieslast_reviewed, and adding it is outside this changept-brupdated in this PR or follow-upi18nissue created:pt-brpartials and pages are in this PRpnpm build:local(build + frontmatter check) without errors