Menyarankan peningkatan kualitas konten

Jika kamu menemukan masalah pada dokumentasi Kubernetes, atau mempunyai ide untuk konten baru, maka silakan untuk membuat isu pada Github. Kamu hanya membutuhkan sebuah akun Github dan sebuah web browser.

Pada kebanyakan kasus, pekerjaan dalam dokumentasi Kubernetes diawali dengan sebuah isu pada Github. Kontributor Kubernetes akan mengkaji, mengkategorisasi dan menandai isu sesuai kebutuhan. Selanjutnya, kamu atau anggota lain dari komunitas Kubernetes dapat membuat pull request dengan perubahan yang akan menyelesaikan masalahnya.

Membuka sebuah issue

Jika kamu mau menyarankan peningkatan kualitas pada konten yang sudah ada, atau menemukan kesalahan, maka silakan membuka sebuah isu.

  1. Turun ke bagian bawah dari suatu halaman dan klik pada tombol Buat Isu. Ini akan mengantarmu pada halaman Github isu dengan beberapa tajuk yang telah diisi.
  2. Deskripsikan isu atau saran untuk peningkatan kualitas. Sediakan detail sebanyak mungkin yang kamu bisa.
  3. Klik Submit new issue

Setelah dikirim, cek isu yang kamu buat secara berkala atau hidupkan notifikasi Github. Pengulas (reviewer) atau anggota komunitas lainnya mungkin akan menanyakan pertanyaan sebelum mereka mengambil suatu tindakan terhadap isumu.

Menyarankan konten baru

Jika kamu memiliki ide untuk konten baru, tapi kamu tidak yakin dimana mengutarakannya, kamu tetap dapat membuat sebuah isu. Antara lain:

  • Pilih halaman pada bagian yang menurutmu konten tersebut berhubungan dan klik Buat Isu.
  • Pergi ke Github dan langsung membuat isu.

Bagaimana cara membuat isu yang bagus

Perhatikan hal berikut ketika membuat sebuah isu:

  • Memberikan deskripsi isu yang jelas. Deskripsikan apa yang memang kurang, tertinggal, salah atau konten mana yang memerlukan peningkatan kualitas.
  • Jelaskan dampak spesifik dari isu terhadap pengguna.
  • Batasi cakupan dari sebuah isu menjadi ukuran pekerjaan yang masuk akal. Untuk masalah dengan cakupan yang besar, pecah isu itu menjadi beberapa isu lebih kecil. Misal, "Membenahi dokumentasi keamanan" masih sangat luas cakupannya, tapi "Penambahan detail pada topik 'Pembatasan akses jaringan'" adalah lebih spesifik untuk dikerjakan.
  • Mencari isu yang sudah ada untuk melihat apakah ada sesuatu yang berhubungan atau mirip dengan isu yang baru.
  • Jika isu yang baru berhubungan dengan isu lain atau pull request, tambahkan rujukan dengan menuliskan URL lengkap atau dengan nomor isu atau pull request yang diawali dengan karakter #. Contohnya, Diajukan oleh #987654.
  • Mengikuti Kode Etik Komunitas. Menghargai kontributor lain. Misalnya, "Dokumentasi ini sangat jelek" adalah contoh yang tidak membantu dan juga bukan masukan yang sopan.
Last modified July 05, 2020 at 12:30 AM PST: ID translation for suggest-improvements (ef4c104cf)