Référence de la syntaxe AsciiDoc - Amazon EKS

Aidez à améliorer cette page

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Pour contribuer à ce guide de l'utilisateur, cliquez sur le GitHub lien Modifier cette page sur qui se trouve dans le volet droit de chaque page.

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Référence de la syntaxe AsciiDoc

AsciiDoc est le langage de balisage privilégié pour la documentation AWS. Même si l’outil prend partiellement en charge la syntaxe Markdown (par exemple, les titres et les listes), nous recommandons d’utiliser la syntaxe AsciiDoc pour l’ensemble du contenu afin d’assurer la cohérence et un rendu correct.

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

Nouvelle page

Chaque nouveau document AsciiDoc doit commencer avec la structure définie dans Création d’une nouvelle page.

En-têtes

Utilisez des en-têtes 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 la casse phrase pour les en-têtes de la documentation AWS.

Formatage du texte

Formatez le texte pour souligner 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 des éléments sans ordre particulier :

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

Listes ordonnées

Créez des listes numérotées pour des étapes séquentielles ou des éléments par ordre de priorité :

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

Pour plus d’informations sur la manière de formater correctement les liens, consultez Insérer un lien. Les liens de type Markdown ne sont pas pris en charge.

Exemples de code

Code incorporé

Utilisez des accents graves pour le code incorporé :

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

Blocs de code

Créez des blocs de code avec coloration de syntaxe et prise en charge d’attributs (similaires aux entités AsciiDoc) :

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

Images

Insérez des images avec du texte alternatif pour l’accessibilité :

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

Tables

Créez des tables 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 AsciiDoc sur les tables.

Alertes

Utilisez des alertes 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

Ceci est une alerte de type note.

Inclusion d’autres fichiers

Inclure du contenu provenant d’autres fichiers :

include::filename.adoc[]

Attributs (similaires aux entités)

Utilisez des attributs prédéfinis pour assurer 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 fichier ../attributes.txt.

Procédures

Formater les procédures étape par étape :

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