Referência de sintaxe do AsciiDoc

AsciiDoc é a linguagem de marcação de preferência da documentação da AWS. Embora as ferramentas tenham suporte parcial para a sintaxe Markdown (como cabeçalhos e listas), recomendamos usar a sintaxe AsciiDoc para todo o conteúdo para garantir consistência e renderização adequada.

Este guia aborda elementos de sintaxe comuns de que você precisará ao contribuir com a documentação do Amazon EKS. Para obter uma sintaxe mais avançada e informações detalhadas, consulte a documentação do AsciiDoc.

Nova página

Cada novo documento AsciiDoc deve começar com a estrutura definida em Criação de uma nova página.

Títulos

Use cabeçalhos para organizar seu conteúdo hierarquicamente:

= Page/topic title (level 1)
== Section title (level 2)
=== Level 3 heading
==== Level 4 heading
===== Level 5 heading
====== Level 6 heading

Observação: sempre use letras maiúsculas e minúsculas de frase para cabeçalhos na documentação da AWS.

Formatação de texto

Formate o texto para enfatizar informações importantes:

Use *bold text* for UI labels.
Use _italic text_ for introducing terms or light emphasis.
Use `monospace text` for code, file names, and commands.

Listas

Listas não ordenadas

Crie listas com marcadores para itens sem uma sequência específica:

* First item
* Second item
** Nested item
** Another nested item
* Third item

Listas ordenadas

Crie listas numeradas para etapas sequenciais ou itens priorizados:

. First step
. Second step
.. Substep 1
.. Substep 2
. Third step

Links

Consulte Inserir um link para obter detalhes sobre como formatar links corretamente. Links no estilo Markdown não são compatíveis.

Exemplos de código

Código em linha

Use acentos graves para código em linha:

Use the `kubectl get pods` command to list all pods.

Blocos de código

Crie blocos de código com destaque de sintaxe e suporte para atributos (semelhantes a entidades):

 [source,python,subs="verbatim,attributes"]
 ----
 def hello_world():
     print("Hello, World!")
 ----

Imagens

Insira imagens com texto alternativo para acessibilidade:

image::images/image-file.png[Alt text description]

Tabelas

Crie tabelas para organizar as informações:

[%header,cols="2"]
|===
|Header 1
|Header 2

|Cell 1,1
|Cell 1,2

|Cell 2,1
|Cell 2,2
|===

Para tabelas mais complexas, consulte a documentação da tabela do AsciiDoc.

Chamadas

Use avisos para destacar informações e advertências importantes:

NOTE: This is a note callout for general information.

TIP: This is a tip callout for helpful advice.

IMPORTANT: This is an important callout for critical information.

Versão prévia:

nota

Este é um aviso de observação.

Incluir outros arquivos

Inclua conteúdo de outros arquivos:

 include::filename.adoc[]

Atributos (similares a entidades)

Use atributos predefinidos para manter a consistência. Em particular, você DEVE usar atributos para a AWS e arn:aws: .

{aws} provides Amazon EKS as a managed Kubernetes service.

 [source,bash,subs="verbatim,attributes"]
 ----
 aws iam attach-role-policy \
     --role-name AmazonEKSAutoClusterRole \
     --policy-arn {arn-aws}iam::aws:policy/AmazonEKSClusterPolicy
 ----

Para obter uma lista de atributos, consulte o arquivo ../attributes.txt.

Procedimentos

Procedimentos passo a passo do formato:

To create an Amaozon EKS cluster. do the following steps.

. Sign in to the {aws} Management Console.
. Open the Amazon EKS console.
. Choose *Create cluster*.

...