Kontribusi untuk Catatan Rilis

Tim Dokumentasi Fedora <https://discussion.fedoraproject.org/tag/docs> v0.0.1, 2022-09-26

Bagian ini menjelaskan cara berkontribusi pada Catatan Rilis Fedora. Sebelum Anda mulai mengikuti prosedur ini, pastikan Anda memenuhi semua persyaratan yang tercantum dalam Persyaratan.

Proses kontribusi Catatan Rilis berada di halaman terpisah karena berbeda dari dokumentasi Fedora lainnya. Jika Anda tertarik untuk berkontribusi pada dokumentasi lain, lihat halaman yang sesuai.

Catatan Rilis memiliki keunikan karena, berbeda dengan semua dokumentasi lainnya, mereka ditulis hampir sepenuhnya dari awal untuk setiap rilis baru, sementara semua dokumentasi lainnya dipertahankan antara rilis, hanya dengan pembaruan. Ini berarti bahwa beberapa bagian dari prosedur di bawah ini, seperti cabang Git yang digunakan atau jadwal, berubah dengan setiap rilis baru. Sebelum Anda mulai menulis catatan rilis, lihat tag #docs di Fedora Discussion, khususnya sidebar di sebelah kanan. Anda akan menemukan informasi terkini di sana.

Cara berkontribusi pada Catatan Rilis Fedora

  1. Periksa sidebar pada Diskusi Fedora, dan perhatikan informasi yang disediakan: Rilis, jadwal, cabang, dan tautan ke daftar masalah yang relevan.

  2. Pilih satu atau lebih masalah dari daftar masalah yang terbuka dan belum ditugaskan untuk rilis yang ingin Anda kontribusikan.

  3. Buka setiap edisi yang Anda pilih, lalu klik tombol “Ambil” di sebelah kanan untuk mengklaimnya.

    Jika Anda mengklaim suatu masalah, tetapi kemudian menyadari bahwa Anda tidak memiliki waktu untuk menyelesaikannya, segera hapus diri Anda dari masalah tersebut agar orang lain dapat mengambil alih.

  4. Cari informasi tentang masalah Anda. Banyak di antaranya sudah memiliki banyak informasi di dalamnya, terutama di tautan Wiki; jika Anda membutuhkan lebih banyak, cari tahu siapa yang bertanggung jawab atas perubahan tersebut (juga tercantum di halaman Wiki yang tertaut dalam masalah), dan sebutkan mereka dengan @ di komentar masalah atau hubungi mereka melalui IRC/Matrix atau email. Ingatlah bahwa selalu lebih baik jika Anda mencoba melakukan riset sebelum mengajukan pertanyaan. Perlu diingat bahwa Anda mungkin tidak selalu dapat menghubungi pemilik dalam waktu yang wajar; dalam hal itu, lakukan yang terbaik, jika ada yang salah, kita selalu dapat memperbarui nanti.

  5. Tulis catatan rilis tentang masalah tersebut. Jika Anda tidak yakin bagaimana tepatnya catatan rilis seharusnya terlihat, lihat beberapa rilis sebelumnya untuk inspirasi. Kami tidak ingin teks yang panjang dan terlalu teknis; catatan rilis umumnya dimaksudkan untuk menyoroti perubahan, bukan untuk menjelaskan cara menggunakan sesuatu.

  6. Sekarang alur kerja akan berbeda tergantung pada izin Pagure dan keterampilan teknis Anda:

    • Jika Anda tahu cara menggunakan Git dan ASCIIDoc, buatlah catatan rilis dan kirimkan permintaan pull ke repositori utama. Pastikan Anda membuka permintaan pull terhadap cabang yang benar, bukan main - lihat langkah pertama prosedur ini untuk informasi lebih lanjut. (Cabang main hanya digunakan sebagai templat untuk setiap rilis baru, jadi hanya berisi struktur kosong dan beberapa halaman yang tidak berubah antar rilis.) Kontribusi Anda harus dimasukkan ke salah satu berkas di modules/release-notes/pages/, berkas mana yang tepat tergantung pada isi perubahan yang Anda dokumentasikan.

Jika Anda tidak dapat melihat bagian di mana Anda menambahkan kontribusi Anda sama sekali, pastikan bagian tersebut termasuk dalam daftar isi di modules/release-notes/nav.adoc.

+ * Jika penjelasan di atas terdengar seperti omong kosong bagi Anda, itu tidak masalah. Cukup tambahkan komentar dengan teks Anda ke dalam masalah tersebut, dan seseorang akan mengeditnya dan menambahkannya ke dokumen akhir.

Ulangi langkah di atas sebanyak yang Anda inginkan.

Want to help? Learn how to contribute to Fedora Docs ›