Skip to content

docs(style-guide): standardize Azion Console click paths - #2596

Merged
marcus-souza-azion merged 2 commits into
mainfrom
docs/mm-16248-console-paths
Nov 12, 2026
Merged

marcus-souza-azion merged 2 commits into
mainfrom
docs/mm-16248-console-paths

Conversation

@bruno-andrade-azion

@bruno-andrade-azion bruno-andrade-azion commented Nov 5, 2026 •

Copy link
Copy Markdown
Contributor

What & why

Related issue: MM-16248 · Epic MM-16212
Pages affected: /en/documentation/style-guide/writing/procedures/ and /pt-br/documentacao/guia-de-estilo/escrita/procedimentos/; About Azion Console (en and pt-br); about 150 page pairs with a Console procedure; the migration-guide partials in src/includes/migration-guides/; and the three API version notices in src/includes/snippets/, which render on about 50 pages.

The convention. The style guide now sets one form for Azion Console click paths, in en and pt-br. The path names only what the reader selects: Access [Azion Console](https://console.azion.com/) > **<menu item>**. It leaves out the menu, because the Console gives it no label and there is no "Products menu", and it leaves out the menu sections (Build, Secure, Edge Libraries…), because the section an item sits in changes with the account type and the item label does not. Account pages use … and, in the account menu, select **<entry>**, and a later step uses Go to **<item>**. The menu labels were checked against the Console's public bundle: the menu items are Firewalls, WAF Rules, and Custom Pages; the account menu holds Account Settings, Variables, Personal Token, and Activity History; the sections are headings with no link.

Applying it. The convention is applied in en and pt-br in step. This covers the Products menu chains, the section prefixes, the "three horizontal lines, upper-left corner" sentences, separate sign-in steps merged into the first step, **Firewall** → **Firewalls**, **Account** > **Personal Token** → the account-menu form, chains moved out of <DocStep> titles, and the Console link always set to https://console.azion.com/. The three API version notices now say "the Azion Console menu" instead of Products menu.

About Azion Console matches the current Console menu: the Store section, Connectors, Custom Pages, Firewalls, and the Copilot header button. Variables moved to the account menu. The section is now called "Console menu", the prose name the style guide sets.

Rebased on main. The branch was rebased on af6a3697c. The five migration guides now share their procedures as partials (#2619), so the convention is applied to the partials (waf-console, rate-limit-console, env-vars-console, certificate-console, en and pt-br) instead of the guide pages. The create-certificate pair was deleted on main (#2593) and stays deleted. The pt-br origins.mdx now says conteúdo ou aplicação, as #2621 left that line to this PR.

Left as is on purpose:

How it was checked:

  • A search for these old forms (Products menu, section prefixes, "three horizontal lines", a Console step linking to a docs page, Go to [Azion Console], Acesse o [Azion Console], **Account** menu, the Console link without its trailing slash) over src/content/docs, src/includes/migration-guides, and src/includes/snippets returns only the style guide's own Incorrect example, the release notes, the Real-Time Metrics tabs, and the pages being retired.
  • The build-free link check returns the same 115 broken links as main, so this PR adds none.
  • The new style-guide section parses as two lists of two items each, in en and pt-br.
  • The docs write-time gate reports no new findings on the files edited during the rebase.
  • Not run: pnpm build:local.

Open items, not fixed here:

  • The Feedback button that About Azion Console describes is not in the current header. Its location needs confirming.
  • pt-br trabalhar-com-variaveis.mdx L162 has 7.Clique with no space, so the line does not render as a list item.

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

Author checklist

  • PR title follows type(scope): summary (see GOVERNANCE.md §4)
  • Frontmatter complete: title, description, meta_tags, namespace, permalink, last_reviewed — no frontmatter field is added or removed; last_reviewed is on no page in the corpus
  • No legacy "edge-" product names in the copy — the Edge strings on the lines this PR edits are Console labels (Edge Libraries, Edge Services, Edge Nodes, Edge Pulse) or prose already on the line before it (Edge Node in the Orchestrator first-steps pair), which this PR does not rename
  • How-to/tutorial content includes at least one runnable, copy-paste-tested code block — no runnable code block is added or changed; the style guide gains one mdx example fence
  • Screenshots (if any) have alt text and follow image standards — no screenshot is added or changed
  • Internal links are relative and resolve locally
  • If any permalink changed or page moved: redirect added in this PR — no permalink changes
  • i18n: pt-br updated in this PR or follow-up i18n issue created: pt-br updated in this PR
  • I ran pnpm build:local (build + frontmatter check) without errors — not run; CI runs the build

@marcus-souza-azion

Copy link
Copy Markdown
Contributor

This PR rewrites the pt-br menu-principal/referencia/build/edge-application/origins.mdx line 56, which still says localizar seu conteúdo ou aplicativo. MM-16253 (#2621) replaces aplicativo with aplicação for the customer's own software, per guia-de-estilo/convencoes/paginas-bilingues.mdx, and leaves this line to your PR so the two don't conflict. Could you change it to localizar seu conteúdo ou aplicação here?

egermano and others added 2 commits November 12, 2026 14:08
Set one convention for Console click paths in the style guide (en and
pt-br): the path names only what the reader selects, as in
`Access [Azion Console](https://console.azion.com/) > **<menu item>**`.
It drops "Products menu", the menu sections, and icon or position text,
since the Console menu has no such label and the section of an item
changes with the account type. Account pages use the account-menu form
and later steps use "Go to".

Apply the convention to the en and pt-br pages in step, and update
About Azion Console to the current Console menu (Store, Connectors,
Custom Pages, Firewalls, Copilot).
Main moved the migration-guide procedures into partials, so apply the
convention there (WAF, rate limit, variables, certificate, en and
pt-br). Replace "Products menu" in the three API version notices, point
the remaining docs-link first steps at the Console, align the
secure-journey mTLS steps, the account-menu wording, and the pt-br
"Acesse o" steps, separate the style guide's example list from the rule
list, tag its new fence as mdx, and use "aplicação" in the pt-br
origins page.
@marcus-souza-azion
marcus-souza-azion force-pushed the docs/mm-16248-console-paths branch from bc2efac to fc5b62f Compare November 12, 2026 17:08
@marcus-souza-azion marcus-souza-azion changed the title docs(style-guide): standardize Azion Console click paths (MM-16248) docs(style-guide): standardize Azion Console click paths Nov 12, 2026
@marcus-souza-azion
marcus-souza-azion merged commit 5a7ecbc into main Nov 12, 2026
10 checks passed
@marcus-souza-azion
marcus-souza-azion deleted the docs/mm-16248-console-paths branch November 12, 2026 17:16
marcus-souza-azion added a commit that referenced this pull request Nov 12, 2026
- static-cache and dynamic-and-static-file-optimization: keep the
  correction from #2626. When the origin sends no cache settings, the
  template applies the Max Age of the cache setting, not a default TTL.
- framework-next (en and pt-br): point the static exports link to the
  renamed heading anchor.
- edge-function-starter-kit: drop "Products menu" from the Console path,
  as #2596 does.
- langgraph-template: link the backend variables section by its anchor.
- Docusaurus and pt-br LangGraph descriptions: trim to 160 characters.
bruno-andrade-azion pushed a commit that referenced this pull request Nov 12, 2026
* 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
* 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 pushed a commit that referenced this pull request Nov 12, 2026
Resolve the 16 conflicts in the current Orchestrator how-tos: keep the
PR's Console-only layout with main's Console steps (#2596) and the
authorize additions from #2588.

Rebuild the 16 -v3 pages from main's version of each page, so they carry
the Console click paths (#2596), the #2574 review fixes, the pt-br link
and aside fixes (#2620, #2622), and the authorize additions (#2588).

Also apply the PR review:
- en create-service: move the active-service note out of the step list
  and drop its contractions
- en descriptions: start with the verb instead of "Learn how to"
- pt-br run-scripts: replace the "borda" DocButton labels

Refs MM-16233
bruno-andrade-azion pushed a commit that referenced this pull request Nov 12, 2026
Conflicts resolved per block:
- Template guides (10 en + 10 pt-br): keep this branch's rewritten
  Applications steps, which already use the Console path from #2596.
- azion-starter-kit (en, pt-br): keep this branch's structure and carry
  #2626's fix into it: when the origin sends no cache settings, the
  template uses the Max Age of the cache setting, not a default TTL.
- Templates overview (en, pt-br): keep main's Astro rows from #2595 and
  this branch's azion/azion-starter Deploy slug.
- liveness-detection (en, pt-br): keep this branch's deletion; its URL
  redirects already exist in redirects/{en,pt-br}/01.json.
- nav/redirects.json: main's version without the liveness entry, since
  lint-navcheck rejects an entry whose page is gone.
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.

3 participants