Skip to content

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

Open
bruno-andrade-azion wants to merge 1 commit into
mainfrom
docs/mm-16248-console-paths
Open

bruno-andrade-azion wants to merge 1 commit 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

Summary

  • Sets one convention for Azion Console click paths in the style guide, in en and pt-br (writing/procedures / escrita/procedimentos). The path names only what the reader selects: Access [Azion Console](https://console.azion.com/) > **<menu item>**. It leaves out Products menu, the menu sections (Build, Secure, Edge Libraries…), and any icon or screen-position text. Account pages use … and, in the account menu, select **<entry>**, and a later step uses Go to **<item>**. The reason the sections go: the Console menu has no "Products menu" label, and the section an item sits in changes with the account type, while the item label does not. This was checked against the Console bundle and current screenshots.
  • Applies the convention to about 145 page pairs, en and pt-br in step. That covers the Products menu chains, the section prefixes, the "three horizontal lines, upper-left corner" sentences, separate sign-in steps merged into the canonical 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/.
  • Updates About Azion Console to match 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.

How to test

  1. Run pnpm build:local. Behind a TLS-intercepting proxy it needs NODE_USE_SYSTEM_CA=1, because the pricing page fetches its data at build time. The build should finish with Complete!.
  2. Open /en/documentation/style-guide/writing/procedures/ and /pt-br/documentacao/guia-de-estilo/escrita/procedimentos/. Read What the path leaves out and Account pages and later steps.
  3. Open /en/documentation/guides/platform/account-and-billing/getting-to-know-azion-console/ and compare the Console menu table with the Console menu.
  4. Spot-check a few pages from the diff, such as the Functions quickstart, a Marketplace template guide, and Activity History. Each Console procedure should start with Access Azion Console > <item>, without Products menu or a section name.
  5. Optional: grep -rniE "products menu|three horizontal lines|\*\*(Secure|Edge Libraries|Libraries)\*\* >" apps/docs/src/content/docs/{en,pt-br} should return only the style guide examples, the release notes, the pages being retired by docs(secure): retire the pre-Workloads security journey and guide pages #2586 and docs(platform): retire the v3 build and deploy journey pages #2587, and the products menu meta keyword on About Azion Console (en and pt-br).

URL changes and redirects

None.

Notes

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).

This branch has not been deployed

No deployments
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.

2 participants