Mengedit dokumentasi Microsoft Learn di browser

Tip

Jalur pembelajaran langkah demi langkah mandiri tersedia untuk topik ini.

Beberapa set dokumentasi Microsoft sumber terbuka dan dihosting di GitHub. Meskipun tidak semua set dokumentasi sepenuhnya sumber terbuka, banyak yang memiliki repositori yang menghadap publik di mana Anda dapat menyarankan perubahan melalui permintaan pull (PR). Pendekatan sumber terbuka ini menyederhanakan dan meningkatkan komunikasi antara teknisi produk, tim konten, dan pelanggan.

Pengeditan cepat memfasilitasi proses untuk melaporkan dan memperbaiki kesalahan dan kelalaian kecil dalam dokumentasi. Terlepas dari semua upaya, kesalahan tata bahasa dan ejaan kecil memang masuk ke dokumen kami yang diterbitkan. Kami menghargai bantuan Anda dalam mengidentifikasi dan memperbaiki masalah ini!

Kami menggunakan PR untuk semua perubahan, bahkan untuk kontributor yang memiliki akses tulis. Sebagian besar repositori melindungi cabang default, sehingga pembaruan harus dikirimkan sebagai PR.

Prasyarat

  • Buat akun GitHub, jika Anda tidak memilikinya.

Mengedit dokumen di browser

  1. Navigasikan ke dokumentasi yang ingin Anda edit. Beberapa halaman dokumen memungkinkan Anda mengedit konten langsung di browser. Jika demikian, Anda akan melihat ikon Edit pensil seperti yang ditunjukkan di bawah ini. Memilih ikon Edit pensil akan membawa Anda ke file sumber di GitHub.

    Cuplikan layar artikel dokumentasi Azure memperlihatkan ikon edit pensil.

    Jika tombol Edit tidak ada, itu berarti konten tidak terbuka untuk kontribusi publik. Beberapa halaman dihasilkan (misalnya, dari dokumentasi sebaris dalam kode) dan harus diedit dalam proyek tempat halaman tersebut berada.

  2. Pilih ikon pensil di bagian atas halaman file GitHub. Jika ikon pensil tidak tersedia (tampak redup) atau tidak ditampilkan, Anda perlu masuk ke akun GitHub Anda.

    Cuplikan layar artikel Azure dalam GitHub, memperlihatkan ikon edit pensil.

    Di bagian atas artikel adalah 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.

  3. Jika ini pertama kalinya Anda bekerja di repositori ini, Anda akan diminta untuk membuat fork repositori sebelum mengusulkan perubahan. Pilih Fork repositori ini untuk melanjutkan.

  4. Edit file di editor web. Pilih tab Pratinjau pada toolbar untuk memeriksa pemformatan perubahan Anda.

  5. Setelah selesai mengedit, pilih tombol Terapkan perubahan atau Usulkan perubahan , biasanya di kanan atas layar.

  6. Masukkan pesan penerapan. Pesan penerapan menjadi judul PR Anda dan harus menjadi ringkasan singkat perubahan Anda (misalnya, "Perbaiki kesalahan ejaan dan tata bahasa"). Secara opsional, tambahkan deskripsi Diperpanjang untuk memberikan detail selengkapnya tentang perubahan Anda. Pilih Usulkan perubahan:

    Cuplikan layar pop-up usulan perubahan.

  7. Sekarang setelah Anda mengusulkan dan menerapkan perubahan Anda, Anda perlu meminta pemilik repositori untuk "menarik" perubahan Anda ke repositori mereka. Ini dilakukan menggunakan permintaan pull (PR). Saat Memilih Usulkan perubahan, Anda akan melihat halaman seperti ini:

    Cuplikan layar membandingkan perubahan.

    PR Anda mengusulkan perubahan dari fork dan cabang Anda (diwakili oleh dua item di sisi kanan panah) ke dalam fork dan main cabang utama repositori dokumentasi (diwakili oleh dua item di sisi kiri panah).

    Tinjau perubahan Anda, lalu pilih Buat permintaan pull.

  8. Pada halaman Buka permintaan pull, pratinjau PR Anda. Anda dapat mengubah bidang judul atau deskripsi jika diperlukan. Setelah siap, pilih Buat permintaan pull. Tindakan ini membuka PR Anda dan memperingatkan pemilik artikel bahwa Anda telah mengusulkan perubahan.

  9. Itu saja! Anggota tim konten akan meninjau PR Anda dan menggabungkannya saat disetujui. Anda mungkin mendapatkan umpan balik yang meminta perubahan. Untuk detail selengkapnya tentang memproses PR Anda, lihat Memproses permintaan pull.

Batasan

  • Sebagian besar konten yang dilokalkan (yaitu, diterjemahkan) tidak menawarkan kemampuan untuk mengedit melalui GitHub. Namun, Anda dapat memberikan umpan balik tentang kualitas terjemahan dengan memilih tombol Umpan Balik (jempol) di bagian atas halaman lalu memilih alasan kualitas Terjemahan. Anda juga dapat meninggalkan umpan balik yang lebih spesifik tentang konten yang dilokalkan dengan menggunakan formulir Berikan Umpan Balik .
  • Pengalaman pengeditan di browser berfungsi paling baik untuk perubahan kecil dan jarang. Jika Anda membuat kontribusi besar atau menggunakan fitur Git tingkat lanjut (seperti manajemen cabang atau resolusi konflik penggabungan lanjutan), kami sarankan Anda membuat fork repositori dan bekerja secara lokal.