Berkontribusi dalam Quick Docs

Tim Dokumen Fedora. Versi all versions Last review: 2023-08-25
Tujuan kami adalah beralih dari wiki, di mana panduan bermanfaat tercampur dengan dokumen draf dan catatan internal, ke panduan langkah demi langkah yang terstruktur berdasarkan topik dan tutorial yang kaya akan kode, dengan alur kerja berbasis pull request. Kami menghargai bantuan Anda!

Langkah-langkah

  1. Pilih dokumen yang akan diperbarui. Anda dapat menemukan dokumen yang memerlukan pembaruan di berkas modules/ROOT/nav.adoc. Dokumen-dokumen tersebut terdapat pada baris yang dikomentari (yang dimulai dengan //FIXME).

  2. Fork repositori https://pagure.io/fedora-docs/quick-docs.

  3. Lakukan perubahan pada berkas .adoc yang ingin Anda perbaiki.

  4. Buka komentar pada berkas nav.adoc dan hapus FIXME dari xref..

  5. Build pratinjau lokal untuk memastikan perubahan Anda terlihat sesuai dengan yang Anda inginkan: Pastikan Anda telah menginstal Podman atau Docker, Pada desktop Linux, jalankan ./docsbuilder.sh. Di macOS, jalankan ./docsbuilder.sh -p atau ./preview.sh. Ikuti petunjuk yang ditampilkan di baris perintah.

  6. Setelah Anda puas dengan pembaruan Anda, kirimkan pull request dengan perbaikan yang Anda lakukan.

  7. Jika memindahkan halaman wiki, buat pengalihan di halaman lama — lihat di bawah.

Bahan Acuan yang Mungkin

Mungkin Anda hanya ingin memperbaiki dokumen yang sudah ada, dalam hal ini, hal-hal di atas sudah cukup. Atau mungkin Anda sudah memiliki ide tertentu. Namun, jika Anda tertarik untuk membantu tetapi tidak tahu harus mulai dari mana, berikut adalah beberapa tempat untuk mencari ide:

  • Kategori How To yang lama di wiki Fedora. Banyak dokumen di sana sudah siap untuk dikonversi. (Banyak juga yang sudah sangat usang!)

  • Masalah Umum pertanyaan di Ask Fedora.

  • Pertanyaan Fedora di Stack Exchange yang sering muncul.

  • Artikel di Fedora Magazine. Format majalah ini bersifat percakapan dan dimaksudkan untuk mewakili momen tertentu. Versi Quick Docs harus lebih ringkas dan jelas, serta diperbarui jika perintah atau praktik terbaik berubah.

Pengalihan Wiki

Biasanya, wiki tidak mengizinkan pengalihan ke situs eksternal, karena potensi penyalahgunaan sangat tinggi. Kami telah mengembangkan plugin untuk Fedora Wiki yang memungkinkan pengalihan hanya ke halaman di situs ini, https://docs.fedoraproject.org/. Untuk membuat tautan semacam itu, gunakan makro #fedoradocs dengan menambahkan baris seperti ini di bagian atas halaman wiki yang akan diganti:

{{#fedoradocs: https://docs.fedoraproject.org/en-US/council/fpl/}}

Tentu saja, Anda harus mengganti URL contoh tersebut dengan URL halaman tujuan baru Anda. Sekali lagi, URL tidak boleh sembarangan—harus dimulai dengan https://docs.fedoraproject.org/.

Setelah pengalihan (redirect) diterapkan, pengunjung ke halaman wiki tersebut akan langsung diarahkan (yaitu, dialihkan dengan kode 301 Moved Permanently) ke situs dokumentasi.

Perhatikan bahwa tidak ada validasi bahwa tujuan yang dituju ada atau benar — harap periksa kembali bahwa semua pengalihan yang Anda buat berfungsi dengan baik sebelum melanjutkan.

Jika Anda perlu mengedit halaman tersebut untuk memperbaiki URL, atau menghapus pengalihan (redirect) karena suatu alasan, buat URL situs wiki dengan &action=edit, seperti:

https://fedoraproject.org/w/index.php?title=Project_Leader&action=edit

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