Skip to content

docs(style-guide): adopt the jsonl tag for JSON Lines samples - #2642

Merged
marcus-souza-azion merged 1 commit into
mainfrom
docs/adopt-jsonl-tag
Nov 12, 2026
Merged

docs(style-guide): adopt the jsonl tag for JSON Lines samples#2642
marcus-souza-azion merged 1 commit into
mainfrom
docs/adopt-jsonl-tag

Conversation

@marcus-souza-azion

@marcus-souza-azion marcus-souza-azion commented Nov 12, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

What & why

Related issue: MM-16258
Pages affected: /en/documentation/style-guide/components/ · /en/documentation/style-guide/formatting/code/

A JSON Lines sample, such as the NDJSON request body on the Data Stream payload page, holds one JSON value per line. Tagged json, it fails the code-block lint from #2623, because a json block must be one JSON document. #2628 tags it jsonl, but the style guide did not list that tag, and the code block bar showed the raw jsonl. This PR adopts the tag so #2628 follows the guide.

The style guide

  • Components: jsonl joins the list of language tags in use, with the rule that JSON Lines is jsonl, not json.
  • Code: the JSON rule keeps one key per line, so JSON Lines needed an exception, since it carries one value per line by definition. The bar names list now says that jsonl reads JSON Lines.

The code block

  • CodeBlock.vue labels jsonl as JSON Lines in the bar. Highlighting does not change.

This PR carries a style guide change and the one-line label it describes. They ship together, because the guide would otherwise name a bar label the site does not show.

How I checked it

  • prettier --check passes on the three files, and eslint --max-warnings 0 passes on CodeBlock.vue.
  • The docs style gate reports no finding on the two style guide pages.
  • Not verified: I did not run the build or open the pages on the dev server.

Type of change

  • 🆕 New content (feat)
  • 🩹 Fix (fix) — typo, broken link, wrong information
  • ♻️ Content update (docs) — rewrite, expansion, upkeep
  • 🌐 Translation sync (i18n)
  • 🏗️ Platform / structure (refactor / chore) — reviewed by UXE, no content mixed in — the one-line label in CodeBlock.vue travels with the style guide text that names it

Author checklist

  • PR title follows type(scope): summary (see GOVERNANCE.md §4)
  • Frontmatter complete: title, description, meta_tags, namespace, permalink, last_reviewed — the two pages have every key but last_reviewed, which no page in the repo carries yet; this PR leaves frontmatter unchanged
  • No legacy "edge-" product names in the copy
  • How-to/tutorial content includes at least one runnable, copy-paste-tested code block — no how-to or tutorial is changed
  • Screenshots (if any) have alt text and follow image standards — no screenshot is added or changed
  • Internal links are relative and resolve locally — no link is added or changed
  • If any permalink changed or page moved: redirect added in this PR — no permalink changed and no page moved
  • i18n: pt-br updated in this PR or follow-up i18n issue created: — the style guide has no pt-br version
  • I ran pnpm build:local (build + frontmatter check) without errors — not run

@marcus-souza-azion
docs(style-guide): adopt the jsonl tag for JSON Lines samples
3b9ffe9 
List jsonl among the fence tags, let JSON Lines keep one value per line,
and label the tag JSON Lines in the code block bar.
@marcus-souza-azion
marcus-souza-azion requested a review from a team November 12, 2026 15:21
@marcus-souza-azion
marcus-souza-azion requested a review from a team as a code owner November 12, 2026 15:21
@marcus-souza-azion marcus-souza-azion mentioned this pull request Nov 12, 2026
Open
8 of 14 tasks
@marcus-souza-azion
marcus-souza-azion merged commit fea46fb into main Nov 12, 2026
10 checks passed
@marcus-souza-azion
marcus-souza-azion deleted the docs/adopt-jsonl-tag branch November 12, 2026 15:26
@github-actions github-actions Bot mentioned this pull request Nov 12, 2026
Open
bruno-andrade-azion pushed a commit that referenced this pull request Nov 12, 2026
@egermano
Merge remote-tracking branch 'origin/main' into fix/mm-16229-review
1c8836a 
* origin/main: (39 commits)
  fix(terminology): replace desempenho and aplicativo in pt-br pages (#2621)
  docs(observe): fix dataset name, Data Stream filter, and Grafana Data path (#2573)
  fix(fundamentals): rewrite the Load Balancer steps in minimize-downtime from the reference (#2578)
  i18n(pt-br): label unlabelled asides and fix label casing (#2622)
  fix(links): point pt-br links to their existing pt-br pages (#2620)
  i18n(pt-br): resync the drifted release notes, punctuation, and Edge Services pairs (#2624)
  i18n(pt-br): pair three pages with their English versions by namespace (#2625)
  docs(style-guide): adopt the jsonl tag for JSON Lines samples (#2642)
  chore(lint): check the changelog entries a PR adds (#2634)
  [NO-ISSUE] ci: replace technote-space/assign-author (SO-5131) (#2591)
  fix(structure): tag bare code fences, fix heading skips, add pt-br meta_tags (#2629)
  docs(style-guide): drop the nonexistent GlossaryFilter from the glossary template (#2577)
  docs(release-notes): fix the October 14 anchor and merge the duplicate February 24 entry (#2572)
  fix(orchestrator): fix broken bind and create-service API samples (#2574)
  docs(readability): split the long sentences in the Runtime, CLI, Reference, and KV Store pages (#2635)
  chore(nav): count only visible rows toward the navcheck soft max (#2640)
  docs(nav): triage the pages outside the navigation (#2593)
  fix(guides): match the QStash variable and the Functions usage response to the code (#2571)
  feat(nav): give every breadcrumb crumb a page and make CLI commands runnable (#2636)
  fix(cli): drop azion update workload-deployment, which the CLI does not expose (#2639)
  ...

# Conflicts:
#	apps/docs/src/content/docs/en/pages/store/sql-database/glossary.mdx
#	apps/docs/src/content/docs/pt-br/pages/store/sql-database/glossario.mdx
bruno-andrade-azion pushed a commit that referenced this pull request Nov 12, 2026
@egermano
Merge remote-tracking branch 'origin/main' into review/mm-16289
2ed4904 
* origin/main: (53 commits)
  docs(style-guide): standardize Azion Console click paths (#2596)
  docs(store): name the SQL and Storage libraries by their scoped packages (#2575)
  fix(terminology): replace desempenho and aplicativo in pt-br pages (#2621)
  docs(observe): fix dataset name, Data Stream filter, and Grafana Data path (#2573)
  fix(fundamentals): rewrite the Load Balancer steps in minimize-downtime from the reference (#2578)
  i18n(pt-br): label unlabelled asides and fix label casing (#2622)
  fix(links): point pt-br links to their existing pt-br pages (#2620)
  i18n(pt-br): resync the drifted release notes, punctuation, and Edge Services pairs (#2624)
  i18n(pt-br): pair three pages with their English versions by namespace (#2625)
  docs(style-guide): adopt the jsonl tag for JSON Lines samples (#2642)
  chore(lint): check the changelog entries a PR adds (#2634)
  [NO-ISSUE] ci: replace technote-space/assign-author (SO-5131) (#2591)
  fix(structure): tag bare code fences, fix heading skips, add pt-br meta_tags (#2629)
  docs(style-guide): drop the nonexistent GlossaryFilter from the glossary template (#2577)
  docs(release-notes): fix the October 14 anchor and merge the duplicate February 24 entry (#2572)
  fix(orchestrator): fix broken bind and create-service API samples (#2574)
  docs(readability): split the long sentences in the Runtime, CLI, Reference, and KV Store pages (#2635)
  chore(nav): count only visible rows toward the navcheck soft max (#2640)
  docs(nav): triage the pages outside the navigation (#2593)
  fix(guides): match the QStash variable and the Functions usage response to the code (#2571)
  ...

# Conflicts:
#	apps/docs/src/content/docs/en/pages/main-menu/reference/accounts/personal-tokens.mdx
#	apps/docs/src/content/docs/en/pages/main-menu/reference/services/support/http-error-status-codes.mdx
#	apps/docs/src/content/docs/pt-br/pages/menu-principal/referencia/contas/personal-tokens.mdx
bruno-andrade-azion pushed a commit that referenced this pull request Nov 12, 2026
@egermano
Merge remote-tracking branch 'origin/main' into fix/mm-16234-merge-main
1b61603 
* origin/main: (48 commits)
  docs(templates): list the Astro templates that only the showcase covered (#2595)
  docs(orchestrator): consolidate duplicate guides and write How it works (#2588)
  docs(secure): retire the pre-Workloads security journey and guide pages (#2586)
  docs(applications): Run Function needs only Functions; fix WEBP and CORS prerequisites (#2580)
  docs(fundamentals): apply the reader review and the style guide to the Fundamentals pages (#2558)
  fix(observe): name the query editor list instead of its position in the Grafana guides (#2643)
  docs(templates): migrate the legacy template guides to the current guide pattern (#2597)
  docs(style-guide): standardize Azion Console click paths (#2596)
  docs(store): name the SQL and Storage libraries by their scoped packages (#2575)
  fix(terminology): replace desempenho and aplicativo in pt-br pages (#2621)
  docs(observe): fix dataset name, Data Stream filter, and Grafana Data path (#2573)
  fix(fundamentals): rewrite the Load Balancer steps in minimize-downtime from the reference (#2578)
  i18n(pt-br): label unlabelled asides and fix label casing (#2622)
  fix(links): point pt-br links to their existing pt-br pages (#2620)
  i18n(pt-br): resync the drifted release notes, punctuation, and Edge Services pairs (#2624)
  i18n(pt-br): pair three pages with their English versions by namespace (#2625)
  docs(style-guide): adopt the jsonl tag for JSON Lines samples (#2642)
  chore(lint): check the changelog entries a PR adds (#2634)
  [NO-ISSUE] ci: replace technote-space/assign-author (SO-5131) (#2591)
  fix(structure): tag bare code fences, fix heading skips, add pt-br meta_tags (#2629)
  ...

# Conflicts:
#	apps/docs/src/content/docs/en/pages/main-menu/reference/accounts/billing.mdx
#	apps/docs/src/content/docs/en/pages/main-menu/reference/accounts/teams-permissions.mdx
#	apps/docs/src/content/docs/pt-br/pages/menu-principal/referencia/contas/faturamento.mdx
#	apps/docs/src/content/docs/pt-br/pages/menu-principal/referencia/contas/teams-permissions.mdx
@bruno-andrade-azion bruno-andrade-azion mentioned this pull request Nov 13, 2026
Open
9 of 14 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@marcus-souza-azion marcus-souza-azion

Labels

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@marcus-souza-azion