Cara mengedit file di antarmuka web Pagure

Hanku Lee Versi F33 and newer Last review: 2023-04-18

Bagian ini menjelaskan cara berkontribusi pada dokumentasi yang sudah ada - yaitu, dokumentasi yang sudah dipublikasikan di situs web. Sebelum Anda mulai mengikuti prosedur ini, pastikan Anda memenuhi semua persyaratan yang tercantum di Persyaratan.

Jika Anda tertarik untuk berkontribusi pada Catatan Rilis, lihat halaman yang sesuai.

Setiap halaman Fedora Docs dilengkapi dengan tautan "Edit this Page" di bagian atas. Untuk pembaruan sederhana, perubahan dapat dikirimkan langsung melalui antarmuka web Pagure. Untuk perubahan yang lebih besar atau kompleks, Anda disarankan untuk menyiapkan dan menguji perubahan Anda secara offline sebelum mengirimkannya.

Pengeditan online di Pagure

  1. Klik tautan "Edit this Page" untuk memuat sumber dokumentasi. Anda akan diarahkan ke repositori konten yang sesuai di Pagure.

  2. Di atas daftar sumber di sisi kanan, klik "Fork dan Edit". (Jika Anda sudah melakukan fork pada repositori ini, tombol ini akan bertuliskan "Edit di fork Anda" dan Anda dapat langsung melanjutkan ke langkah berikutnya.)

    1. Jika Anda belum masuk ke Pagure, Anda akan diminta untuk memasukkan kredensial Anda.

    2. Tunggu hingga proses selesai. Anda mungkin perlu memperbarui halaman, karena halaman tidak selalu diperbarui secara otomatis setelah proses selesai.

  3. Setelah berkas dimuat ke dalam fork Anda, lakukan perubahan yang diperlukan pada konten, simpan perubahan tersebut ke dalam fork Anda, dan siapkan permintaan pull (PR).

    1. Setiap PR harus diajukan dari cabang (branch) tersendiri di repositori Anda. Di bawah heading "Branch" pada antarmuka commit, pilih "New branch" dan berikan nama yang singkat dan unik untuk cabang tersebut.

    2. Isi formulir pesan commit.

    3. Klik "Commit changes" untuk membuat cabang dan menyimpan perubahan ini ke fork Anda.

  4. Setelah commit disimpan, halaman akan diperbarui ke daftar commit untuk fork Anda.

  5. Untuk menambahkan perubahan tambahan yang terkait, ulangi proses ini dan simpan perubahan tersebut ke cabang yang sama.

  6. Ketika Anda siap, klik "Buat permintaan pull" dan isi formulir PR untuk mengirimkan cabang Anda ke repositori hulu.

Tips untuk melakukan commit di Git

  • Saat memberi nama cabang Anda, gunakan hanya huruf ASCII, angka, tanda hubung (-), dan garis bawah (_). Nama may boleh mengandung titik tunggal (.), tetapi tidak boleh dimulai atau diakhiri dengan titik tunggal. Spasi, dua titik (..), dan sebagian besar tanda baca lainnya tidak diperbolehkan.

  • Judul commit adalah cara edit Anda akan diidentifikasi dalam log repositori untuk halaman tersebut. Judul yang disarankan, "Update pathname", sudah cukup untuk edit kecil. Untuk beberapa tips tentang menulis pesan commit yang baik, lihat commit.style oleh Tim Pope (penulis vim).

  • Gunakan bidang "Commit Description" untuk memberikan detail tambahan jika diperlukan, tetapi jaga agar tetap singkat. Anda akan memiliki kesempatan untuk menjelaskan atau mendiskusikan perubahan Anda saat Anda mengirimkan PR Anda.

Pengeditan offline

  1. Klik tautan "Edit this Page" untuk memuat sumber dokumentasi. Anda akan diarahkan ke repositori konten yang sesuai di Pagure. Setelah menemukan repositori yang benar, buatlah fork jika Anda belum melakukannya:

    1. Di pojok kanan atas, klik Fork.

    2. Jika Anda belum masuk ke Pagure, Anda akan diminta untuk memasukkan kredensial Anda.

    3. Tunggu hingga operasi selesai. Anda mungkin perlu memperbarui halaman tersebut, karena tidak selalu diperbarui secara otomatis setelah proses selesai.

    4. Salin cabang Anda.

  2. Lihat cabang baru, dan tambahkan kontribusi Anda.

  3. Jika Anda menambahkan file baru, pastikan file-file tersebut ditempatkan di lokasi yang wajar dalam berkas konfigurasi nav.adoc repositori

  4. Bangun secara lokal dan pastikan semuanya terlihat sesuai dengan yang Anda harapkan. Lihat Membuat pratinjau lokal untuk petunjuk.

  5. Setelah selesai, simpan perubahan Anda dan unggah ke fork Anda.

  6. Gunakan Pagure untuk membuat pull request dari fork Anda ke branch master repositori utama.

Mengelola permintaan pull Anda

Seseorang akan melihat pull request Anda dan akan menggabungkannya, atau memberikan umpan balik jika ada hal yang perlu Anda ubah. Bekerja sama dengan orang-orang yang memberikan komentar untuk memastikan kontribusi Anda memenuhi standar.

Jika tidak ada yang merespons permintaan pull Anda dalam beberapa hari, coba bahas hal tersebut di salah satu pertemuan mingguan, saluran Matrix (https://matrix.to// docs:fedoraproject.org[#docs] di Fedora Chat), atau milis.

Your changes will appear online sometime after the pull request is merged. The site is being updated every hour. If your changes do not appear online within 24 hours of your PR being merged, ping asamalik (Adam Šamalík) on the IRC channel and ask him about it.

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