Menulis tutorial di Cloud Shell

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

Tutorial adalah seperangkat instruksi yang ditulis dalam Markdown. Cloud Shell membuat tutorial dalam konteks dari file Markdown ini dengan menguraikan teks menjadi langkah dan sub-langkah yang kemudian ditampilkan di panel pada Konsol Google Cloud.

Tutorial yang berjalan di Cloud Shell

Mempelajari tutorial (dengan menggunakan tutorial)

Untuk mempelajari tutorial interaktif dengan mengikuti tutorial interaktif yang sebenarnya, luncurkan tutorial tentang cara menulis tutorial dengan tombol berikut:

Buka di Cloud Shell

Menulis tutorial

Tutorial ditulis dalam CommonMark Markdown. Ekstensi Markdown tambahan didukung, begitu juga perintah, yang menyertakan fungsi lanjutan seperti fitur sorotan dan penambahan ikon inline.

Langkah

Saat membuat tutorial, {i>heading<i} penting dalam menentukan strukturnya. Untuk menetapkan judul, heading langkah, dan petunjuk yang mendasarinya dengan benar, 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 adalah contoh {i>file<i} 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

Perintah mengaktifkan fungsi lanjutan seperti menyoroti fitur dan menambahkan ikon inline.

Untuk menambahkan perintah, gunakan format berikut:

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

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

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

Untuk perintah yang tersedia, lihat referensi perintah.

Buka tutorial di Cloud Shell

Ada dua cara untuk memulai tutorial di Cloud Shell:

  1. Menggunakan perintah cloudshell launch-tutorial

    Jalankan perintah cloudshell berikut dalam sesi Cloud Shell untuk meluncurkan tutorial dari file Markdown yang sudah 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 sudah ada, hello.md:

    teachme hello.md

  2. Gunakan Open in Cloud Shell

    Atau, Anda dapat menggunakan fitur Buka di Cloud Shell untuk memandu pengguna dari situs, blog, atau project open source ke tutorial 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. Ini berarti bahwa Markdown untuk tombol yang ditautkan ke tutorial 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