Menulis tutorial di Cloud Shell

Cloud Shell mendukung pembuatan dan peluncuran tutorial untuk membantu pengguna memahami project Anda dengan cepat dan efektif.

Tutorial adalah sekumpulan petunjuk yang ditulis dalam Markdown. Cloud Shell membuat tutorial dalam konteks dari file Markdown ini dengan mengurai teks menjadi langkah dan sub-langkah yang kemudian ditampilkan di panel di konsol Google Cloud .

Tutorial yang berjalan di Cloud Shell

Menulis tutorial

Tutorial ditulis dalam CommonMark Markdown. Ekstensi Markdown tambahan didukung, seperti halnya direktif, yang mencakup fungsi lanjutan seperti menyoroti fitur dan menambahkan ikon inline.

Langkah

Saat membuat tutorial, judul penting dalam menentukan strukturnya. Untuk menetapkan judul yang benar, judul langkah, dan petunjuk yang mendasarinya, gunakan hierarki berikut:

  • Tag H1 (#) untuk judul tutorial. Hanya boleh ada satu tag H1 dalam tutorial.
  • Tag H2 (##) untuk judul langkah.
  • Tag H3 (###) untuk judul sub-langkah.

Berikut contoh file Markdown yang dapat Anda gunakan untuk membuat tutorial:

# First tutorial

## First step

Hello world

### Part 1

Part one instructions.

### Part 2

Part two instructions.

## Conclusion

Done!

Arahan

Direktif memungkinkan fungsi lanjutan seperti menyoroti fitur dan menambahkan ikon inline.

Untuk menambahkan direktif, gunakan format berikut:

<walkthrough-DIRECTIVE_NAME PARAMETER="PARAMETER_VALUE">
</walkthrough-DIRECTIVE_NAME>

Misalnya, jika Anda ingin menggunakan direktif editor-open-file dan parameter filePath, perintah tersebut akan ditulis sebagai berikut:

<walkthrough-editor-open-file filePath="test/hello.md">
</walkthrough-editor-open-file>

Untuk mengetahui petunjuk yang tersedia, lihat referensi petunjuk.

Meluncurkan tutorial di Cloud Shell

Ada dua cara untuk memulai tutorial di Cloud Shell:

  1. Gunakan perintah cloudshell launch-tutorial

    Jalankan perintah cloudshell berikut di sesi Cloud Shell untuk meluncurkan tutorial dari file Markdown yang ada, tutorial.md:

    cloudshell launch-tutorial tutorial.md

    Atau, Anda dapat menggunakan alias teachme dengan menjalankan perintah berikut di sesi Cloud Shell untuk meluncurkan tutorial dari file yang ada, hello.md:

    teachme hello.md

  2. Menggunakan Buka di Cloud Shell

    Atau, Anda dapat menggunakan fitur Buka di Cloud Shell untuk memandu pengguna dari situs, blog, atau project open source ke tutorial Anda yang dihosting di repositori Git. Fitur Open in Cloud Shell memungkinkan parameter cloudshell_tutorial, yang dapat ditambahkan ke akhir URL untuk menentukan lokasi file Markdown sumber di repositori. Artinya, Markdown untuk tombol yang ditautkan ke tutorial Anda akan terlihat seperti:

    [![Open in Cloud Shell](https://gstatic.com/cloudssh/images/open-btn.png)](https://ssh.cloud.google.com/cloudshell/open?cloudshell_git_repo=GIT_REPO_URL&cloudshell_tutorial=PATH_TO_MD_FILE)

Langkah berikutnya