AsciiDoc référence de syntaxe

AsciiDoc est le langage de balisage préféré pour la AWS documentation. Bien que l'outil supporte partiellement la syntaxe Markdown (comme les en-têtes et les listes), nous recommandons d'utiliser la AsciiDoc syntaxe pour l'ensemble du contenu afin de garantir la cohérence et un rendu correct.

Ce guide couvre les éléments de syntaxe courants dont vous aurez besoin pour contribuer à la documentation Amazon EKS. Pour une syntaxe plus avancée et des informations détaillées, reportez-vous à la AsciiDoc documentation.

Nouvelle page

Chaque nouveau AsciiDoc document doit commencer par la structure définie dansCréez une nouvelle page.

En-têtes

Utilisez des titres pour organiser votre contenu de manière hiérarchique :

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

Remarque : utilisez toujours des majuscules pour les titres de la AWS documentation.

Formatage du texte

Formatez le texte pour mettre en valeur les informations 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.

Listes

Listes non ordonnées

Créez des listes à puces pour les éléments sans séquence spécifique :

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

Listes ordonnées

Créez des listes numérotées pour les étapes séquentielles ou les éléments prioritaires :

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

Liens

Consultez Insérer un lien pour plus de détails sur la manière de formater correctement les liens. Les liens de style Markdown ne sont pas pris en charge.

Exemples de code

Code en ligne

Utilisez des backticks pour le code en ligne :

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

Blocs de code

Créez des blocs de code avec surlignage syntaxique et prise en charge des attributs (similaires aux entités) :

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

Images

Insérez des images avec du texte alternatif pour des raisons d'accessibilité :

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

Tables

Créez des tableaux pour organiser les informations :

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

|Cell 1,1
|Cell 1,2

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

Pour des tables plus complexes, consultez la documentation relative aux AsciiDoc tables.

Alertes

Utilisez des légendes pour mettre en évidence les informations et les avertissements importants :

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.

Aperçu :

Note

Il s'agit d'une légende.

Inclure d'autres fichiers

Incluez le contenu d'autres fichiers :

 include::filename.adoc[]

Attributs (similaires aux entités)

Utilisez des attributs prédéfinis pour garantir la cohérence. En particulier, vous DEVEZ utiliser des attributs pour AWS et 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
 ----

Pour obtenir la liste des attributs, consultez le ../attributes.txt fichier.

Procédures

step-by-stepProcédures de formatage :

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

...