Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ This script will install the Azion binary in the following path: `/usr/local/bin

## Binding an edge service to an edge node

1. Go to **Edge Nodes**.
1. Access [Azion Console](https://console.azion.com/) > **Edge Nodes**.
2. Select the edge node to which you want to bind a service.
3. Go to the **Services** tab and click the **+ Service** button.
4. Choose the service `Azion CLI Installation` you've created.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ If you've already installed [Azion Orchestrator Agent](/en/documentation/guides/

1. Access [Azion Console](https://console.azion.com/) > **Edge Nodes**.
2. Find the edge node you wish to authorize, which will have the status `Waiting Authorization`.
3. Select the three dots button and then select **Authorize**.
3. Select the three dots icon and then select **Authorize**.
4. Confirm the authorization.

After the authorization, an edge node can take up to 10 seconds before services can be orchestrated on it.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ The application starts the flow. A request to the protected route without the `X
<DocSteps>
<DocStep title="Open the application">

In Azion Console, go to **Applications** and select the application the challenge protects.
Access [Azion Console](https://console.azion.com/) > **Applications**, and select the application the challenge protects.

</DocStep>
<DocStep title="Go to the Rules Engine tab" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ A firewall runs a function only with the **Functions** module turned on. To crea
<DocSteps>
<DocStep title="Open the Firewalls page">

Go to **Firewalls**.
Access [Azion Console](https://console.azion.com/) > **Firewalls**.

</DocStep>
<DocStep title="Select + Firewall" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import DocItem from '@aziontech/webkit/doc-item'

Every product, resource, and account setting you use at Azion is configured from one web interface. Its header carries the menus and buttons that open each area, and its homepage carries shortcuts to the first tasks. That interface is [Azion Console](https://console.azion.com/).

In it, you set up your [Azion account](/en/documentation/fundamentals/creating-account/), [build and deploy applications](/en/documentation/platform/applications/), [manage the main settings of an application](/en/documentation/guides/application-development/getting-started/configure-main-settings/), and configure every Azion product. The [Guides](/en/documentation/guides/) cover the tasks of each one. The sections below cover the homepage, the Console menu, Creation Center, the help, feedback, and Copilot buttons, and the account menu, in that order. To sign up or sign in, refer to [Access Azion Console](/en/documentation/guides/platform/account-and-billing/how-to-access-azion-console/).
In it, you set up your [Azion account](/en/documentation/fundamentals/creating-account/), [build and deploy applications](/en/documentation/platform/applications/), [manage the main settings of an application](/en/documentation/guides/application-development/getting-started/configure-main-settings/), and configure every Azion product. The [Guides](/en/documentation/guides/) cover the tasks of each one. This page covers the homepage, the Console menu, Creation Center, the help and Copilot buttons, and the account menu. To sign up or sign in, refer to [Access Azion Console](/en/documentation/guides/platform/account-and-billing/how-to-access-azion-console/).

---

Expand Down Expand Up @@ -54,7 +54,7 @@ The other entries sit in sections, each named for a stage of the work:
| **Tools** | **Real-Time Purge** |
| **Edge Libraries** | **Certificate Manager**, **Custom Pages**, **Edge Services**, **Functions**, **Network Lists**, **WAF Rules** |

Selecting an entry opens that product with its settings. The sections can change with the type of account, and on some accounts **Domains** takes the place of **Workloads**. The procedures in this documentation name only the entry, as in `Access Azion Console > Firewalls`, so look for the entry by its name.
Selecting an entry opens that product with its settings. The menu can differ with the type of account. Some accounts show **Domains** in place of **Workloads**. Others nest **Applications**, **Firewalls**, and **Custom Pages** under **Workloads**, and leave out entries such as **Marketplace** and **Edge Nodes**. The procedures in this documentation name only the entry, such as **Firewalls**, so look for the entry by its name.

---

Expand All @@ -69,9 +69,9 @@ For what each option offers, refer to [Use the + Create button](/en/documentatio

---

## Help and feedback
## Help and Copilot

The **Help** button shows documentation related to the screen you are on, along with other useful links. The **Feedback** button sends your opinion of Azion Console to Azion. The **Copilot** button opens [Azion Copilot](https://console.azion.com/copilot), an AI assistant with knowledge of every Azion product.
The **Help** button shows documentation related to the screen you are on, along with other useful links. The **Copilot** button opens Azion Copilot in a side panel. Azion Copilot is an AI assistant with knowledge of every Azion product.

:::note
The **Help Center** does not carry documentation for every Console screen.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,7 @@ To create a ticket, you first need to access the **Support Center**. You have th
</Fragment>

<Fragment slot="panel.console">
1. Access [Azion Console](https://console.azion.com/).
2. On the header, click **Help** > **Contact Support**.
Access [Azion Console](https://console.azion.com/) and, in the header, select **Help** > **Contact Support**.
</Fragment>

</Tabs>
Expand Down Expand Up @@ -81,7 +80,7 @@ Add the following information to your ticket's description:
If you've already opened a ticket and want to check on its status, follow the next steps:

1. Access [Support Center](https://tickets.azion.com/en/support/login).
- Alternatively, access [Azion Console](https://console.azion.com/) and select **Help** > **Contact Support**.
- Alternatively, access [Azion Console](https://console.azion.com/) and, in the header, select **Help** > **Contact Support**.
2. On the Support Center homepage, click on the **Tickets** tab > **Check ticket status**. You'll access a page with your **Open or Pending** tickets.
3. Optionally, you can filter your tickets by:
- Clicking on **Open or Pending** and selecting between **All Tickets**, **Open or Pending**, or **Resolved or Closed**.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ To create the first rule:
<DocSteps>
<DocStep title="Open the firewall bound to your workload">

In Azion Console, go to **Firewalls** and select that firewall.
Access [Azion Console](https://console.azion.com/) > **Firewalls**, and select that firewall.

</DocStep>
<DocStep title="Select the Rules Engine tab" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,9 @@ Numbering starts when the procedure has two or more actions. An API procedure's
The path names only what the reader selects, so it leaves out two things:

- **The menu.** The Console gives it no label: a **Menu** button opens it, and every item sits in it. Do not write `**Products menu**`, and do not describe the button by its icon or its place on the screen, per [Accessibility](/en/documentation/style-guide/writing/accessibility/). In prose, call it the Console menu.
- **The menu sections**, such as **Build**, **Secure**, **Store**, **Observe**, or **Edge Libraries**. A section is a heading, not an item, and the section of an item can change with the type of account. The item label does not.
- **The menu sections.** Sections such as **Build**, **Secure**, **Store**, **Observe**, or **Edge Libraries** are headings, not items. The section of an item can change with the type of account. The item keeps its label, except **Workloads**, which some accounts show as **Domains**.

For example:

For example, a path to **Functions**:

Expand All @@ -44,7 +46,7 @@ For example, a path to **Functions**:

Where each item sits in the menu is the job of [About Azion Console](/en/documentation/guides/platform/account-and-billing/getting-to-know-azion-console/), not of each procedure.

A chain starts at a Console menu item or at a labeled header button, then follows what the reader selects: `> **Create** > **Templates**`. Tabs and filters inside a page keep their own chain, as in a Real-Time Metrics dashboard: `> **Real-Time Metrics**`, then `**Build** > **Applications**` in the next step.
A chain starts at a Console menu item or at a header button with visible text, such as **Create**, then follows what the reader selects: `> **Create** > **Templates**`. The **Menu** button never starts a chain. Tabs and filters inside a page keep their own chain, as in a Real-Time Metrics dashboard: `> **Real-Time Metrics**`, then `**Build** > **Applications**` in the next step.

## Account pages and later steps

Expand All @@ -54,7 +56,7 @@ The account menu has no label to put in a chain either. A page that sits in it,
1. Access [Azion Console](https://console.azion.com/) and, in the account menu, select **<Entry>**.
```

A later step that moves to another menu item starts with `Go to`: `Go to **Firewalls** > **your firewall**.` Never restate the menu or the Console in that step.
A later step that moves to another menu item starts with `Go to`: `Go to **Firewalls** > **your firewall**.` Never restate the menu in that step.

A `<DocStep>` title carries no chain, because a title renders no bold. Name the step in plain words, such as `Access Azion Console` or `Open the Firewalls page`, and write the path in its body.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Este script instalará o binário `azion` no seguinte caminho: `/usr/local/bin`

## Vincule um edge service a um edge node

1. Vá para **Edge Nodes**.
1. Acesse [Azion Console](https://console.azion.com/) > **Edge Nodes**.
2. Selecione o edge node ao qual você deseja vincular um serviço.
3. Vá para a guia **Services** e clique no botão **+ Service**.
4. Escolha o serviço `Instalação Azion CLI` que você criou.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ Cada ação de interface recebe um verbo, o mesmo em todas as páginas. A tabela

Em inglês dos EUA, "enable" e "disable" continuam legítimos para descrever estado em prosa: "When WAF is enabled on the firewall, requests pass through it."

Os procedimentos publicados em português do Brasil usam "acesse", "selecione", "digite", "defina" e "ative"/"desative" (para switches e toggles); nunca "clique".
Os procedimentos publicados em português do Brasil usam "acesse", "vá para", "selecione", "digite", "defina" e "ative"/"desative" (para switches e toggles); nunca "clique".

Não use linguagem direcional. Nomeie o elemento, conforme [Acessibilidade](/pt-br/documentacao/guia-de-estilo/escrita/acessibilidade/).

Expand Down Expand Up @@ -141,6 +141,8 @@ Em português do Brasil, o artigo antes de um nome de recurso da plataforma é n

A regra de retirar o artigo vale só para o texto em inglês dos EUA, em que um nome de recurso da plataforma não leva artigo: `Access Azion Console.`, nunca `Access the Azion Console.`

A exceção é o primeiro passo canônico de um procedimento no Console, uma string fixa sem artigo: `Acesse [Azion Console](https://console.azion.com/) > **Functions**.` As formas desse passo estão em [Procedimentos](/pt-br/documentacao/guia-de-estilo/escrita/procedimentos/).

## Use a grafia do inglês dos EUA

Nos trechos em inglês dos EUA, escreva `organize`, `behavior` e `license`. Grafias britânicas entram em páginas copiadas da documentação de fornecedores, então confira as que diferem.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Procedimentos no Console começam com a string canônica:
1. Acesse [Azion Console](https://console.azion.com/) > **<Recurso da plataforma>**.
```

Preencha o recurso da plataforma com o rótulo que o menu do Console dá a ele: `> **Object Storage**`, `> **Firewalls**`. Uma navegação mais profunda estende a cadeia: `> **Applications** > **sua aplicação**`. O link sempre aponta para `https://console.azion.com/`, com a barra no final.
Preencha o recurso da plataforma com o rótulo que o menu do Console dá a ele: `> **Object Storage**`, `> **Firewalls**`. Uma navegação mais profunda estende a cadeia: `> **Applications** > **sua aplicação**`. O link sempre aponta para `https://console.azion.com/`, com a barra no final. O passo não leva artigo antes de Azion Console, uma exceção registrada em [Escolha de palavras](/pt-br/documentacao/guia-de-estilo/escrita/escolha-de-palavras/).

Um procedimento de um único comando não é uma lista numerada. Escreva uma frase de introdução terminada em dois-pontos e depois o comando:

Expand All @@ -35,7 +35,9 @@ A numeração começa quando o procedimento tem duas ou mais ações. A introdu
O caminho nomeia só o que o leitor seleciona, então ele deixa duas coisas de fora:

- **O menu.** O Console não dá rótulo a ele: um botão **Menu** o abre, e todos os itens ficam nele. Não escreva `**Products menu**` nem `**Menu de produtos**`, e não descreva o botão pelo ícone ou pela posição na tela, conforme [Acessibilidade](/pt-br/documentacao/guia-de-estilo/escrita/acessibilidade/). Na prosa, chame-o de menu do Console.
- **As seções do menu**, como **Build**, **Secure**, **Store**, **Observe** ou **Edge Libraries**. Uma seção é um título, não um item, e a seção de um item pode mudar com o tipo de conta. O rótulo do item não muda.
- **As seções do menu.** Seções como **Build**, **Secure**, **Store**, **Observe** ou **Edge Libraries** são títulos, não itens. A seção de um item pode mudar com o tipo de conta. O item mantém o rótulo, exceto **Workloads**, que algumas contas mostram como **Domains**.

Por exemplo:

Por exemplo, um caminho até **Functions**:

Expand All @@ -44,7 +46,7 @@ Por exemplo, um caminho até **Functions**:

Onde cada item fica no menu é papel de [Sobre Azion Console](/pt-br/documentacao/guias/plataforma/conta-e-billing/conhecendo-o-azion-console/), não de cada procedimento.

Uma cadeia começa em um item do menu do Console ou em um botão do cabeçalho que tenha rótulo, e segue o que o leitor seleciona: `> **Create** > **Templates**`. Abas e filtros dentro de uma página mantêm a própria cadeia, como em um dashboard do Real-Time Metrics: `> **Real-Time Metrics**` e, no passo seguinte, `**Build** > **Applications**`.
Uma cadeia começa em um item do menu do Console ou em um botão do cabeçalho com texto visível, como **Create**. Ela segue o que o leitor seleciona: `> **Create** > **Templates**`. O botão **Menu** nunca começa uma cadeia. Abas e filtros dentro de uma página mantêm a própria cadeia, como em um dashboard do Real-Time Metrics: `> **Real-Time Metrics**` e, no passo seguinte, `**Build** > **Applications**`.

## Páginas da conta e passos seguintes

Expand All @@ -54,9 +56,9 @@ O menu da conta também não tem rótulo para entrar em uma cadeia. Uma página
1. Acesse [Azion Console](https://console.azion.com/) e, no menu da conta, selecione **<Entrada>**.
```

Um passo seguinte que vai para outro item do menu começa com `Vá para`: `Vá para **Firewalls** > **seu firewall**.` Nunca repita o menu ou o Console nesse passo.
Um passo seguinte que vai para outro item do menu começa com `Vá para`: `Vá para **Firewalls** > **seu firewall**.` Nunca repita o menu nesse passo.

Um título de `<DocStep>` não leva cadeia, porque o título não renderiza negrito. Nomeie o passo em palavras simples, como `Acesse Azion Console` ou `Abra a página Firewalls`, e escreva o caminho no corpo dele.
Um título de `<DocStep>` não leva cadeia, porque o título não renderiza negrito. Nomeie o passo em palavras simples, como `Acesse o Azion Console` ou `Abra a página Firewalls`, e escreva o caminho no corpo dele.

## Uma ação por passo

Expand Down Expand Up @@ -84,7 +86,7 @@ A condição vem antes da ação: `Se a lista estiver vazia, selecione **Add**.`
- Comece um passo opcional com a palavra literal `(Opcional)`: `3. (Opcional) Digite uma descrição para a regra.`
- Marque subpassos com letras minúsculas (`a.`, `b.`) e o nível seguinte com números romanos minúsculos. Se um passo precisa desse terceiro nível, o procedimento pede divisão.
- Use negrito no rótulo da interface e itálico no valor: `Defina **Workloads Access** como _Read Only_.`
- Use apenas os verbos da interface. Em inglês dos EUA: select, go to, turn on, turn off, enter; nunca click, hit, enable, disable. Em português do Brasil, os procedimentos usam acesse, selecione, digite, defina e ative/desative; nunca clique. A tabela está em [Escolha de palavras](/pt-br/documentacao/guia-de-estilo/escrita/escolha-de-palavras/).
- Use apenas os verbos da interface. Em inglês dos EUA: select, go to, turn on, turn off, enter; nunca click, hit, enable, disable. Em português do Brasil, os procedimentos usam acesse, vá para, selecione, digite, defina e ative/desative; nunca clique. A tabela está em [Escolha de palavras](/pt-br/documentacao/guia-de-estilo/escrita/escolha-de-palavras/).
- Use as palavras da própria interface. Se o botão diz **Save**, o passo diz selecione **Save**, não "confirme" ou "aplique". Não melhore o vocabulário da interface na prosa que a descreve.
- Não use linguagem direcional. Nomeie o elemento, não onde ele fica na tela, conforme [Acessibilidade](/pt-br/documentacao/guia-de-estilo/escrita/acessibilidade/).
- Mantenha cada frase em 20 palavras e cada passo com uma instrução. O orçamento procedural está em [Estrutura de frases](/pt-br/documentacao/guia-de-estilo/escrita/estrutura-de-frases/).
Expand Down
Loading
Loading