Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season Dokumen.
Ringkasan proyek
- Organisasi open source:
- Cloud Native Computing Foundation (CNCF)
- Penulis teknis:
- Syam Sundar K
- Nama proyek:
- Contoh Kubectl yang Lebih Banyak dan Lebih Baik
- Durasi proyek:
- Durasi standar (3 bulan)
Project description
Tujuan project ini adalah untuk meningkatkan kualitas dokumen referensi dan cheat sheet kubectl yang ada.
Berikut ini adalah tujuan akhir project ini: • Membuat contoh kubectl yang lebih banyak dan lebih baik. • Tambahkan contoh kubectl ke tips praktis kubectl. • Memfaktorkan ulang dokumen kubectl agar dapat bermanfaat secara maksimal.
Sasaran I - Contoh untuk kubectl:
Kami akan bekerja sama dengan grup minat khusus CLI guna mendapatkan konteks dan contoh seperti apa yang paling diinginkan para pengguna kubernetes serta mendokumentasikannya. Hal ini dapat berkisar dari meningkatkan perintah kubectl yang ada di lembar contekan hingga menambahkan perintah baru ke lembar contekan.
Sasaran II - Peningkatan Kegunaan dokumen:
Untuk meningkatkan kegunaan dokumen, hal berikut dapat dilakukan:
• Menghilangkan perjuangan pemula • Mengatur ulang perintah kubectl dalam urutan tertentu untuk memastikan kontinuitas dalam alur logis
Hilangkan perjuangan pemula dengan penjelasan perintah / kasus pengguna yang lebih baik. Hal ini mungkin tampak sederhana tetapi dapat sangat memengaruhi pemula untuk melanjutkan atau menghentikan pembelajaran mereka. Sebagai contoh, ketika saya mulai menggunakan kubernetes melalui kubectl, saya tidak yakin tentang perbedaan antara pod dan deployment. Awalnya, saya men-deploy layanan backend yang ditulis dalam nodejs. Setelah beberapa jam, saya ingin menghentikannya, jadi saya mencoba menghapus pod, tetapi pod dibuat kembali karena sifat pemulihan mandiri pod. Saya agak bingung dengan apa yang sedang terjadi dan bertanya-tanya mengapa hal itu dibuat ulang dan tidak dihapus. Setelah beberapa kali pencarian di web, saya menemukan bahwa menghapus pod tidak sama dengan menghapus deployment. Bagi orang-orang yang terlatih, hal ini mungkin tampak sederhana tetapi penjelasan yang jelas yang menghilangkan jenis ambiguitas ini adalah yang membedakan dokumen yang baik dari dokumen yang hebat.
Mengatur ulang perintah kubectl dalam urutan tertentu untuk memastikan kontinuitas dalam alur logis. Jika Anda orang seperti saya yang sangat percaya bercerita, Anda mungkin bertanya-tanya, bagaimana cara membawa elemen penceritaan ke dalam lembar dokumen yang memiliki daftar perintah terminal, saya katakan, hal itu dapat dilakukan. Apa pun yang kita pelajari selalu memiliki alur logis - titik awal dan akhir, jika Anda mau. Kubectl sebagai alat command line, jelas memiliki kurva pembelajaran, bahkan kurva pembelajarannya bertepatan dengan kurva pembelajaran Kubernetes itu sendiri. Karena hampir semua orang memulai perjalanan mereka dengan kubernetes melalui kubectl (kecuali orang-orang yang menggunakan UI web) dan karena kurva pembelajarannya terkait erat dengan kurva pembelajaran kubernetes, dokumen ini dapat dibuat lebih baik secara signifikan hanya dengan mengubah urutan perintah ini dan memperkenalkan elemen bercerita di dalamnya. Misalnya, untuk suatu instance, 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 luar biasa dan merupakan perubahan besar dalam perspektif dokumen. Meskipun migrasi berhasil, masih ada ruang untuk banyak peningkatan di ruang dokumen.
Berikut ini beberapa perubahan yang akan saya sarankan,
• Scroll otomatis di panel kiri ke bagian yang sedang aktif di dokumen utama - Hal ini dapat membantu melacak bagian saat ini, yang akan datang, dan yang lalu. • Salin ke papan klip - beberapa perintah bisa panjang, fungsi salin dapat berguna saat bekerja dengan jenis perintah ini. • Pemformatan Konten file dokumen - Setelah migrasi, konten di beberapa halaman tidak diformat dengan cara yang benar. misalnya: bagian Jenis Resource di ringkasan kubectl. Hal ini akan menurunkan pengalaman pengguna.
Berbagai perubahan ini dapat meningkatkan pengalaman pengguna di situs kubernetes dan juga dapat mendongkrak produktivitas pengguna.