AsciiDoc Syntaxreferenz

AsciiDoc ist die bevorzugte Auszeichnungssprache für die AWS Dokumentation. Das Tool unterstützt zwar teilweise die Markdown-Syntax (wie Überschriften und Listen), wir empfehlen jedoch, die AsciiDoc Syntax für alle Inhalte zu verwenden, um Konsistenz und korrekte Darstellung zu gewährleisten.

Dieses Handbuch behandelt allgemeine Syntaxelemente, die Sie benötigen, wenn Sie zur Amazon EKS-Dokumentation beitragen. Eine fortgeschrittenere Syntax und detaillierte Informationen finden Sie in der AsciiDoc Dokumentation.

Neue Seite

Jedes neue AsciiDoc Dokument sollte mit der Struktur beginnen, die in definiert istEine neue Seite erstellen.

Überschriften

Verwenden Sie Überschriften, um Ihre Inhalte hierarchisch zu organisieren:

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

Hinweis: Verwenden Sie für Überschriften in der Dokumentation immer die Groß-/Kleinschreibung. AWS

Formatierung von Text

Formatieren Sie Text, um wichtige Informationen hervorzuheben:

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

Listen

Ungeordnete Listen

Erstellen Sie Listen mit Aufzählungszeichen für Artikel ohne eine bestimmte Reihenfolge:

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

Geordnete Listen

Erstellen Sie nummerierte Listen für aufeinanderfolgende Schritte oder priorisierte Elemente:

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

Links

Einzelheiten Fügen Sie einen Link ein zur korrekten Formatierung von Links finden Sie unter. Links im Markdown-Stil werden nicht unterstützt.

Codebeispiele

Inline-Code

Verwenden Sie Backticks für Inline-Code:

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

Codeblöcke

Erstellen Sie Codeblöcke mit Syntaxhervorhebung und Unterstützung für Attribute (ähnlich wie Entitäten):

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

Bilder

Fügen Sie aus Gründen der Barrierefreiheit Bilder mit Alt-Text ein:

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

Tabellen

Erstellen Sie Tabellen, um Informationen zu organisieren:

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

|Cell 1,1
|Cell 1,2

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

Komplexere Tabellen finden Sie in der AsciiDoc Tabellendokumentation.

Callouts

Verwenden Sie Beschriftungen, um wichtige Informationen und Ermahnungen hervorzuheben:

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.

Vorschau:

Anmerkung

Dies ist ein Notiz-Callout.

Einschließlich anderer Dateien

Inhalte aus anderen Dateien einbeziehen:

 include::filename.adoc[]

Attribute (ähnlich wie Entitäten)

Verwenden Sie vordefinierte Attribute, um die Konsistenz aufrechtzuerhalten. Insbesondere MÜSSEN Sie Attribute für AWS und verwenden 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
 ----

Eine Liste der Attribute finden Sie in der ../attributes.txt Datei.

Verfahren

step-by-stepProzeduren formatieren:

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

...