AsciiDoc riferimento alla sintassi

AsciiDoc è il linguaggio di markup preferito per la AWS documentazione. Sebbene gli strumenti supportino parzialmente la sintassi di Markdown (come titoli ed elenchi), consigliamo di utilizzare la AsciiDoc sintassi per tutti i contenuti per garantire la coerenza e la corretta visualizzazione.

Questa guida illustra gli elementi di sintassi più comuni necessari per contribuire alla documentazione di Amazon EKS. Per una sintassi più avanzata e informazioni dettagliate, consulta la AsciiDoc documentazione.

Nuova pagina

Ogni nuovo AsciiDoc documento dovrebbe iniziare con la struttura definita inCrea una nuova pagina.

Intestazioni

Usa i titoli per organizzare i tuoi contenuti in modo gerarchico:

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

Nota: usa sempre le lettere maiuscole e minuscole per i titoli della documentazione. AWS

Formattazione del testo

Formatta il testo per enfatizzare le informazioni importanti:

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

Elenchi

Elenchi non ordinati

Crea elenchi puntati per gli elementi senza una sequenza specifica:

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

Elenchi ordinati

Crea elenchi numerati per passaggi sequenziali o elementi con priorità:

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

Link

Inserisci un linkPer ulteriori informazioni su come formattare correttamente i collegamenti, vedere. I link in stile Markdown non sono supportati.

Esempi di codice

Codice in linea

Usa i backtick per il codice in linea:

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

Blocchi di codice

Crea blocchi di codice con evidenziazione della sintassi e supporto per gli attributi (simili alle entità):

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

Immagini

Inserisci immagini con testo alternativo per l'accessibilità:

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

Tabelle

Crea tabelle per organizzare le informazioni:

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

|Cell 1,1
|Cell 1,2

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

Per tabelle più complesse, consulta la documentazione della AsciiDoc tabella.

Callout

Usa i callout per evidenziare informazioni e ammonizioni importanti:

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.

Anteprima:

Nota

Questo è un callout di nota.

Inclusi altri file

Includi contenuti da altri file:

 include::filename.adoc[]

Attributi (simili alle entità)

Utilizza attributi predefiniti per mantenere la coerenza. In particolare, è NECESSARIO utilizzare gli attributi per 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
 ----

Per un elenco degli attributi, cercate nel ../attributes.txt file.

Procedure

step-by-stepProcedure di formattazione:

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

...