Referencia de sintaxis de AsciiDoc

AsciiDoc es el lenguaje de marcado preferido para la documentación de AWS. Si bien las herramientas tienen compatibilidad parcial para la sintaxis de Markdown (como encabezados y listas), recomendamos usar la sintaxis AsciiDoc para todo el contenido a fin de garantizar la coherencia y la representación adecuada.

En esta guía se describen los elementos de sintaxis más comunes que necesitará para contribuir a la documentación de Amazon EKS. Para obtener una sintaxis más avanzada e información detallada, consulte la documentación de AsciiDoc.

Nueva página

Cada documento nuevo de AsciiDoc debe comenzar con la estructura definida en Cómo crear una nueva página.

Encabezados

Use encabezados para organizar su contenido jerárquicamente:

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

Nota: Siempre use la primera letra de la frase en mayúsculas en los encabezados de la documentación de AWS.

Formato de texto

Formatee el texto para resaltar la información importante:

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 sin ordenar

Cree listas con viñetas para los elementos que no tengan una secuencia específica:

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

Listas ordenadas

Cree listas numeradas para los pasos secuenciales o los elementos priorizados:

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

Enlaces

Consulte Cómo insertar un enlace para obtener más información sobre cómo dar formato a los enlaces correctamente. No se admiten los enlaces de estilo Markdown.

Ejemplos de código

Código en línea

Use acentos graves para el código en línea:

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

Bloques de código

Cree bloques de código con resaltado de sintaxis y compatibilidad con atributos (similar a las entidades):

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

Imágenes

Inserte imágenes con texto alternativo para facilitar la accesibilidad:

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

Tablas

Cree tablas para organizar la información:

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

|Cell 1,1
|Cell 1,2

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

Para tablas más complejas, consulte la documentación de la tabla de AsciiDoc.

Avisos

Use anotaciones para resaltar la información importante y las advertencias:

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.

Vista previa:

nota

Esta es una anotación.

Inclusión de otros archivos

Incluya contenido de otros archivos:

 include::filename.adoc[]

Atributos (similares a las entidades)

Utilice atributos predefinidos para mantener la coherencia. En particular, DEBE utilizar atributos para AWS y 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 obtener una lista de atributos, consulte el archivo ../attributes.txt.

Procedimientos

Formatee procedimientos paso a paso:

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

...