Repository navigation
fix(structure): tag bare code fences, fix heading skips, add pt-br meta_tags - #2629
Open
bruno-andrade-azion wants to merge 2 commits into
Open
bruno-andrade-azion wants to merge 2 commits into
bruno-andrade-azion wants to merge 2 commits into
Conversation
…sing pt-br meta_tags - Tag 23 bare code fences in 17 pages (text for output, mdx for page source). A fence without a language reached CodeBlock with no lang, and the highlighter fell back to JavaScript. - Fix heading skips on 30 pages: the agreements "Previous versions" heading becomes an H2, as on the current Terms of Service; the OpenNext guide moves up one level; a pt-br v3 reference H4 becomes H3, as in en. - Add meta_tags to the 15 pt-br Terms of Service pages that lacked it.
9 of 14 tasks
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-16262, in the epic MM-16212
Pages affected: 49 pages in en and pt-br:
The ticket's counts come from the October 29 review. I measured them again on
main, parsing frontmatter withgray-matterand skipping code blocks, and most of them don't hold up:mainmeta_tagsnamespacewritten as>-# ...comment inside a code block or a<Code code={...}>template literal. No page has a real H1 in its body.DocUpdaterenders each entry's date as an<h2>. I left them as they are.Code blocks. A fence with no language reaches
CodeBlockwith nolang, becauseastro-code-blocks.tspassesnode.lang ?? undefined. The webkit highlighter then falls back to JavaScript, so output such asHello World!was tokenized as JavaScript.text, the tag docs(fundamentals): apply the reader review and the style guide to the Fundamentals pages #2558 uses.proceduresthat show page source carrymdx, like the block next to them.Heading levels. No legal text changes.
#### Previous versions of this document:becomes## Previous versions of this document. That's how the current Terms of Service already write it. The anchor doesn't change, and the section now shows in the page's table of contents, as it does on the current terms.###, so every heading moves up one level.meta_tags. Fourteen pt-br Terms of Service pages get'Termos de serviço, Termos de serviço Azion', with the same value and position as the other pt-br terms. The April 26, 2023 page keeps its heading fix but doesn't get themeta_tagsline yet. #2625 rewrites thenamespaceline right below it, so adding it now would conflict. It's a one-line change once #2625 merges.How I checked it:
git merge-treeagainst every open PR that touches these files: docs(applications): Run Function needs only Functions; fix WEBP and CORS prerequisites #2580, docs(platform): retire the v3 build and deploy journey pages #2587, docs(orchestrator): consolidate duplicate guides and write How it works #2588, docs(style-guide): standardize Azion Console click paths (MM-16248) #2596, fix(terminology): replace desempenho and aplicativo in pt-br pages #2621, i18n(pt-br): label unlabelled asides and fix label casing #2622 and i18n(pt-br): pair three pages with their English versions by namespace #2625. Once the April 26meta_tagsline was out, this branch caused no conflict with any of them. docs(applications): Run Function needs only Functions; fix WEBP and CORS prerequisites #2580, docs(platform): retire the v3 build and deploy journey pages #2587 and docs(style-guide): standardize Azion Console click paths (MM-16248) #2596 already conflict withmain, but only in files this PR doesn't touch.docs_gate.py --check) on the 49 files finds nothing new and reports 69 fewer findings thanmain. The ones that go away are the heading skips, the colons in headings and the missingmeta_tags.linkcheck.pyreturns the same result as onmain:/tds/29-agosto-2024/, and one in the pt-br v3 Main Settings reference;pnpm ci:ratchet slugcheckpasses at baseline 6.pnpm ci:ratchet linkcheckpasses on the build: 159 broken links against a baseline of 221. This PR changes no link, so it doesn't account for the drop.pnpm lint:navcheckpasses.pnpm build:localpasses with Node 26: 2,092 pages, plus the frontmatter test. In the built HTML:CodeBlockwithlang: "text"and renders as a single text token;h2with a table-of-contents link;h2;<meta name="keywords" content="Termos de serviço, Termos de serviço Azion">.http-error-status-codes, fixed by docs(fundamentals): apply the reader review and the style guide to the Fundamentals pages #2558) still renders with nolang, andHost example.comsplits into JavaScript type, function and punctuation tokens..mdxin this repository, so it checks nothing here.Type of change
feat)fix) — typo, broken link, wrong informationdocs) — 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— no page in the repository carrieslast_reviewed, and the pt-br April 26, 2023 terms getmeta_tagsonly after i18n(pt-br): pair three pages with their English versions by namespace #2625 mergespt-brupdated in this PR or follow-upi18nissue created: both languages are in this PR; the WebAssembly language guide changes only in pt-br, because docs(nav): triage the pages outside the navigation (MM-16244) #2593 deletes the English pagepnpm build:local(build + frontmatter check) without errors