AsciiDoc referensi sintaks

AsciiDoc adalah bahasa markup yang disukai untuk AWS dokumentasi. Meskipun tooling memiliki dukungan sebagian untuk sintaks Markdown (seperti judul dan daftar), sebaiknya gunakan AsciiDoc sintaks untuk semua konten untuk memastikan konsistensi dan rendering yang tepat.

Panduan ini mencakup elemen sintaks umum yang Anda perlukan saat berkontribusi pada dokumentasi Amazon EKS. Untuk sintaks yang lebih canggih dan informasi rinci, lihat AsciiDoc dokumentasi.

Halaman baru

Setiap AsciiDoc dokumen baru harus dimulai dengan struktur yang didefinisikan dalamBuat halaman baru.

Judul

Gunakan judul untuk mengatur konten Anda secara hierarkis:

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

Catatan: Selalu gunakan kasus kalimat untuk judul dalam AWS dokumentasi.

Pemformatan teks

Format teks untuk menekankan informasi penting:

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

Daftar

Daftar tidak berurutan

Buat daftar berpoin untuk item tanpa urutan tertentu:

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

Daftar yang dipesan

Buat daftar bernomor untuk langkah berurutan atau item yang diprioritaskan:

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

Tautan

Lihat Sisipkan tautan untuk detail tentang cara memformat tautan dengan benar. Tautan gaya penurunan harga tidak didukung.

Contoh kode

Kode sebaris

Gunakan backticks untuk kode inline:

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

Blok kode

Buat blok kode dengan penyorotan sintaks dan dukungan untuk atribut (mirip dengan entitas):

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

Citra

Sisipkan gambar dengan teks alt untuk aksesibilitas:

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

Tabel

Buat tabel untuk mengatur informasi:

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

|Cell 1,1
|Cell 1,2

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

Untuk tabel yang lebih kompleks, lihat dokumentasi AsciiDoc tabel.

Callout

Gunakan callout untuk menyoroti informasi dan peringatan penting:

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.

Pratinjau:

catatan

Ini adalah catatan callout.

Termasuk file lainnya

Sertakan konten dari file lain:

 include::filename.adoc[]

Atribut (mirip dengan entitas)

Gunakan atribut yang telah ditentukan untuk menjaga konsistensi. Secara khusus, Anda HARUS menggunakan atribut untuk AWS dan 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
 ----

Untuk daftar atribut, lihat di ../attributes.txt file.

Prosedur

step-by-stepProsedur format:

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

...