Lorawan-stack: Soal template untuk pertanyaan

jadi "tindakan"nya adalah kami memperbarui dokumentasi secara langsung (jika itu satu-satunya perubahan) yang merujuk pada masalah ini dan membuka yang lain jika ini menghasilkan permintaan perbaikan bug/fitur?

Tepat. Hasil dari masalah "pertanyaan" biasanya berupa perubahan dalam dokumentasi kami, atau tambahan pada FAQ kami.

Saya tidak tahu apakah masuk akal untuk menyalin-menempelkan masalah "pertanyaan" ke dalam masalah "bug_report". Mungkin kita harus menambahkan bagian yang relevan di komentar (atau mengedit masalah) jika kita memutuskan untuk mengubah pertanyaan menjadi laporan atau fitur bug.

Setuju tapi itu juga harus berlaku untuk forum dan slack.

Intinya semua informasi harus ada di dokumentasi repo, jika beberapa informasi referensi di forum, masalah atau slack maka kita gagal membuat dokumentasi.
Pertanyaan atau masalah yang diangkat pada slack, forum harus menebus perubahan dalam dokumen kecuali tidak ada upaya yang dilakukan untuk mencari informasi.

Alih-alih memiliki daftar "apakah Anda melihat di sana", saya akan menambahkan tautan ke kueri di github / doc (setelah pencarian impl) . Mencari informasi dalam masalah github bisa jadi membosankan dan forum tidak boleh menyimpan informasi/penjelasan yang tidak dimiliki doc. Tautan ke kueri yang sudah ada (seperti mencari bug) akan membantu. Menambahkan bagian bug yang diketahui ke dokumen juga dapat dipertimbangkan.

Jika sebuah pertanyaan menyoroti bug, terserah pada pengembang untuk memenuhi syarat sebagai bug (dan mengedit masalah sebagai laporan bug) atau membuka masalah lain jika satu-satunya bagian dari pertanyaan yang melibatkan bug.

Saya sepenuhnya setuju bahwa kita harus memantau Forum dan Slack dengan lebih baik dan mengubah pertanyaan (baik) menjadi peningkatan dokumentasi (setidaknya untuk kategori v3 dan saluran lorawan-stack ). @Sypheos bagaimana Anda melihatnya bekerja dalam praktik?

Tujuan dari "sudahkah Anda melihat ke sini" lebih merupakan filter bagi orang-orang yang mengirimkan masalah sebelum melakukan pencarian sama sekali. Bagian selanjutnya lebih berguna, di sana kita dapat meminta pengirim masalah untuk menautkan (atau mengutip) posting forum yang relevan, pesan kendur, dll.

Saya pikir ini adalah ide yang bagus. Mari kita jaga agar ruang lingkup masalah ini dan template masalah benar-benar menjadi pertanyaan baru.

Untuk perbaikan dokumentasi, yaitu jawaban informal di forum dan Slack yang kami inginkan sebagai bagian dari dokumentasi, kami dapat mempertimbangkan template masalah "permintaan dokumentasi" tambahan, yang minimal; itu pada dasarnya menjelaskan celah dokumentasi dan tautan ke tempat informasi sekarang jika ada (yaitu tautan ke forum/pesan Slack). Tetapi sekali lagi, bagi saya, di luar cakupan masalah ini.

Untuk template pertanyaan imo:
Apa yang dicari / dilakukan?
Di mana Anda melihat?
_Tambahkan halaman web, masalah, kueri apa pun terhadap github, dokumen, forum dipersilakan_
Mengapa tidak memuaskan?
_404 tidak ditemukan adalah jawaban yang sah_

Label: pertanyaan

jika tidak ada sumber daya untuk menjawab pertanyaan, buka masalah "permintaan dokumentasi".

Kita harus benar-benar memastikan bahwa jawaban apa pun berakhir dalam dokumentasi, jika tidak, masalah tertutup di sini menjadi basis pengetahuan V3, dan kita harus menghindarinya. Jadi mungkin kita harus melewatkan template "pertanyaan" dan langsung menuju "permintaan dokumentasi".

Juga, ketika penggunaan repositori ini meningkat, dan ini menjadi tujuan utama untuk mengajukan pertanyaan dan kami mengalami kesulitan memoderasi itu (yaitu menunjuk ke dokumen dan menutup masalah), kami mungkin menyesalinya di masa mendatang. Perhatikan bahwa repositori yang lebih besar seperti VS Code menyampaikan bahwa Anda tidak boleh mengajukan pertanyaan dengan cukup agresif:

Singkatnya, mari kita pertimbangkan;

• Tidak mengizinkan pertanyaan sama sekali, hanya masalah "permintaan dokumentasi". Pertanyaan masih valid, tetapi hanya jika memang tidak didokumentasikan jika tidak, itu bukan permintaan dokumentasi yang valid dan kami menutupnya
• Pertanyaan langsung ke dokumen (bila kami memilikinya) dan forum

Permintaan dokumentasi sebenarnya adalah "Pertanyaan" karena mereka mencari sesuatu tetapi tidak dapat menemukannya. Pada awalnya mereka memiliki pertanyaan yang membutuhkan jawaban.
Untuk menuju ke arah itu, akan lebih masuk akal untuk menolak permintaan dan pertanyaan dokumentasi apa pun melalui masalah di github.

Jika seseorang ingin mengajukan pertanyaan, mereka pergi ke slack atau forum di mana seseorang untuk tim inti atau moderasi dapat mengubah pertanyaan mereka dalam dokumentasi PR / masalah bug / masalah permintaan fitur.

Keputusan: Kami akan menggunakan https://github.com/TheThingsNetwork/lorawan-stack/issues/890#issuecomment -507324845. Template pertanyaan yang mengarah ke forum, dan template Permintaan Dokumentasi