Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.
Ringkasan project
- Organisasi open source:
- Cloud Native Computing Foundation (CNCF)
- Penulis teknis:
- Syam Sundar K
- Nama project:
- Contoh Kubectl Lainnya dan yang Lebih Baik
- Durasi project:
- Durasi standar (3 bulan)
Project description
Tujuan project ini adalah untuk meningkatkan kualitas cheat sheet dan dokumen referensi kubectl yang sudah ada.
Berikut adalah sasaran utama project ini: • Membuat lebih banyak contoh kubectl yang lebih baik. • Menambahkan contoh kubectl ke cheat sheet kubectl. • Memfaktorkan ulang dokumen kubectl untuk mendapatkan manfaat maksimal.
Sasaran I - Contoh untuk kubectl:
Akan bekerja sama dengan grup minat khusus CLI untuk mendapatkan konteks, jenis contoh yang paling diinginkan pengguna kubernetes, dan mendokumentasikannya. Hal ini dapat mencakup peningkatan perintah kubectl yang ada di tips cepat hingga penambahan perintah baru ke tips cepat.
Sasaran II - Meningkatkan Kegunaan dokumen:
Untuk meningkatkan kegunaan dokumen, hal berikut dapat dilakukan:
• Menghilangkan kesulitan pemula • Mengatur ulang perintah kubectl dalam urutan tertentu untuk memastikan kontinuitas dalam alur logis
Hilangkan kesulitan pemula melalui penjelasan perintah / kasus penggunaan yang lebih baik. Hal ini mungkin tampak sederhana, tetapi dapat secara signifikan memengaruhi pemula untuk melanjutkan atau menghentikan pembelajaran mereka. Misalnya, saat saya mulai menggunakan Kubernetes melalui kubectl, saya tidak yakin dengan perbedaan antara pod dan deployment. Awalnya, saya men-deploy layanan backend yang ditulis dalam nodejs. Setelah beberapa jam, saya ingin menghapusnya. Jadi, saya mencoba menghapus pod tersebut, tetapi karena pod dapat pulih dengan sendirinya, pod tersebut dibuat lagi. Saya agak bingung dengan apa yang terjadi dan ingin tahu mengapa video tersebut dibuat ulang dan tidak dihapus. Setelah melakukan beberapa pencarian di web, saya tahu bahwa menghapus pod tidak sama dengan menghapus deployment. Bagi mata yang terlatih, hal ini mungkin tampak sederhana, tetapi penjelasan yang jelas untuk menghilangkan ambiguitas semacam inilah yang membedakan dokumen yang baik dengan dokumen yang baik.
Mengatur ulang perintah kubectl dalam urutan tertentu untuk memastikan kontinuitas dalam alur logika. Jika Anda seseorang seperti saya yang sangat percaya diri dengan penyampaian cerita, Anda mungkin akan bertanya-tanya, bagaimana cara membawa elemen bercerita ke dalam lembar dokumen yang memiliki daftar perintah terminal, saya katakan, hal itu dapat dilakukan. Apa pun yang kita pelajari selalu memiliki alur yang logis - titik awal dan akhir, jika Anda mau. Kubectl sebagai alat command line, jelas memiliki kurva belajar, bahkan kurva belajarnya bertepatan dengan kurva belajar Kubernetes itu sendiri. Karena hampir semua orang memulai perjalanan mereka dengan kubernetes melalui kubectl (kecuali orang yang menggunakan UI web) dan karena kurva belajarnya sangat terkait dengan kurva belajar kubernetes, dokumen dapat dibuat jauh lebih baik hanya dengan mengubah urutan perintah ini dan memperkenalkan elemen storytelling ke dalamnya. Misalnya, fitur seperti penskalaan otomatis pod horizontal dapat dijelaskan setelah menjelaskan resource dengan contoh dan ilustrasi dunia nyata.
Sasaran III - Peningkatan Kegunaan Dokumen:
Migrasi terbaru situs Kubernetes ke Docsy Hugo sangat bagus dan merupakan perubahan besar dalam perspektif dokumen. Meskipun migrasi berhasil, masih ada banyak ruang untuk peningkatan di ruang dokumen.
Berikut beberapa perubahan yang saya sarankan,
• Panel kiri men-scroll otomatis ke bagian yang saat ini aktif di dokumen utama - Hal ini dapat membantu melacak bagian saat ini, mendatang, dan sebelumnya. • Salin ke papan klip - beberapa perintah bisa panjang, fungsi salin dapat membantu saat menggunakan jenis perintah ini. • Pemformatan Konten file dokumen - Setelah migrasi, konten di beberapa halaman tidak diformat dengan benar. Misalnya: bagian Resource Type di ringkasan kubectl. Hal ini menurunkan pengalaman pengguna.
Berikut adalah perubahan yang dapat meningkatkan pengalaman pengguna di situs kubernetes dan juga dapat meningkatkan produktivitas pengguna.