Mengedit artikel dokumentasi di browser Anda

  • 5 menit

Sekarang setelah Anda memiliki gambaran umum tentang alat umum dan memindahkan bagian di belakang layar kontribusi, mari kita lihat langkah-langkah spesifik untuk membuat kontribusi kecil pada dokumentasi Microsoft. Saat Anda ingin membuat perubahan kecil pada artikel, pertama-tama pastikan Anda memiliki alat yang sesuai yang disiapkan. Kemudian, Anda siap untuk mulai mengedit dan berbagi pengetahuan dengan anggota komunitas Microsoft Learn lainnya.

Langkah 1: Siapkan akun GitHub Anda

Karena Microsoft Learn mengintegrasikan alur kerja GitHub untuk memperbarui konten, Anda memerlukan akun GitHub untuk berkontribusi. Jika Anda sudah memiliki akun GitHub, pastikan Anda masuk.

Jika Anda belum memiliki akun GitHub, gunakan langkah-langkah berikut untuk membuatnya:

  1. Navigasi ke www.github.com
  2. Pilih Daftar masuk.
  3. Ikuti perintah untuk menyiapkan akun Anda.

Langkah 2: Buat perubahan Anda

Ingat, tidak semua konten Microsoft Learn disimpan di repositori publik. Sebelum Anda membuat perubahan, pertama-tama periksa apakah konten yang ingin Anda kontribusikan tersedia untuk kontribusi publik. Jika demikian, Anda dapat membuat perubahan langsung di browser Anda.

  1. Navigasikan ke artikel dokumentasi tentang learn.microsoft.com yang ingin Anda edit. Periksa apakah artikel disimpan di repositori publik dengan mencari ikon Edit berbentuk pensil di bagian atas artikel. Jika Anda melihat ikon, ikon tersebut memenuhi syarat untuk kontribusi publik!

  2. Pilih ikon Edit pensil. Ini membawa Anda ke file sumber di repositori GitHub publik tempat artikel disimpan.

    Screenshot of a Microsoft Learn documentation article with the pencil Edit icon highlighted.

  3. Pilih ikon pensil di bagian atas halaman file GitHub. Ikon ini berlabel Edit file ini di fork Anda dari proyek ini atau Fork repositori ini dan edit file tergantung pada apakah Anda telah membuat fork repositori tempat file disimpan.

    Anda harus masuk ke akun GitHub Anda pada saat ini untuk memilih ikon Edit ini. Jika Anda tidak masuk, opsi ini tidak akan tersedia.

    Screenshot of the GitHub source file for a documentation article. The Edit file pencil icon is highlighted.

    Di bagian atas artikel, Anda akan melihat metadata artikel. Metadata diterapkan ke artikel untuk pelaporan, penemuan melalui pencarian, dan aspek pendorongan pengalaman situs. Jika Anda membuat pembaruan kecil pada artikel yang diterbitkan, Anda mungkin tidak perlu mengubah metadata.

  4. Jika ini pertama kalinya Anda bekerja di repositori ini, Anda diminta untuk membuat fork repositori sebelum mengusulkan perubahan. Jika demikian, pilih Fork repositori ini.

  5. Anda akan melihat antarmuka pengeditan, atau panel Edit , di browser Anda. Anda dapat melihat artikel yang ditulis dalam Markdown, sintaks pemformatan. Buat perubahan Anda di panel.

    Screenshot of a browser with a documentation article written in Markdown syntax, which can be edited in the Edit pane.

  6. Di bagian atas panel pengeditan, pilih tab Pratinjau . Ini memungkinkan Anda memvalidasi perubahan Anda dengan melihatnya dalam formulir yang diterbitkan.

Langkah 3: Buat permintaan pull Anda

Setelah selesai membuat dan mempratinjau perubahan, saatnya untuk membuat permintaan pull (PR). Ingatlah bahwa PR adalah cara Anda mengusulkan bahwa perubahan Anda digabungkan ke cabang utama repositori langsung agar terlihat di Microsoft Learn. PR memungkinkan model kolaborasi GitHub dengan meminta perubahan dari cabang kerja Anda untuk ditarik dan digabungkan ke cabang lain. Dalam kebanyakan kasus, cabang lain ini adalah cabang default di repositori utama.

  1. Temukan dan pilih tombol Terapkan perubahan atau Usulkan perubahan , biasanya di bagian atas halaman.

  2. Tambahkan pesan Terapkan. Ini menjadi judul PR Anda. Pesan penerapan harus berupa ringkasan singkat tentang perubahan Anda. Secara opsional, tambahkan deskripsi Diperpanjang untuk memberikan detail lebih lanjut tentang perubahan Anda.

    Screenshot of the pop up box with two fields to create a Commit message and add an extended description of the changes.

  3. Pilih Usulkan perubahan.

  4. Halaman berikutnya meminta Anda untuk memverifikasi ke mana Anda ingin menggabungkan perubahan, yang disebut basis. Konfirmasikan bahwa basisnya adalah main.

    Screenshot of the webpage where contributors should verify the destination repository and branch they want to merge changes to. Main is selected as the Base.

  5. Pilih Buat permintaan pull.

  6. Pratinjau PR Anda. Buat perubahan apa pun pada bidang judul atau deskripsi.

  7. Pilih tombol Buat permintaan pull. Ini akan membuka permintaan pull Anda.

PR Anda telah dibuat, tetapi belum dikirimkan. Pada langkah berikutnya, Anda akan menyelesaikan langkah-langkah verifikasi akhir di PR Anda untuk menggabungkannya.

Skenario: Edit artikel Azure Apps Service

Ingat bahwa Anda adalah insinyur perangkat lunak dengan keahlian khusus di Azure App Service. Saat meninjau artikel dokumentasi tentang App Service, Anda melihat detail yang ingin Anda tambahkan yang akan membantu orang lain menggunakan layanan. Anda memutuskan untuk membagikan pengetahuan Anda dengan memberikan kontribusi pertama Anda ke Microsoft Learn! Setelah masuk ke akun GitHub, Anda memulai proses kontribusi: