Menyiapkan repositori Git lokal untuk dokumentasi

Artikel ini menjelaskan langkah-langkah untuk menyiapkan repositori Git di komputer lokal Anda, dengan maksud untuk berkontribusi pada dokumentasi Microsoft. Kontributor dapat menggunakan repositori kloning lokal untuk menambahkan artikel baru, melakukan pengeditan utama pada artikel yang ada, atau mengubah karya seni.

Anda akan menjalankan aktivitas penyiapan satu kali ini untuk mulai berkontribusi:

• Tentukan repositori yang sesuai.
• Fork repositori ke akun GitHub Anda.
• Pilih folder lokal untuk file kloning.
• Kloning repositori ke mesin lokal Anda.
• Konfigurasikan nilai jarak jauh upstram.

Penting

Jika Anda hanya membuat perubahan kecil, Anda tidak perlu menyelesaikan langkah-langkah dalam artikel ini. Lihat Mengedit di browser untuk mempelajari cara melakukan pengeditan cepat tanpa menginstal alat apa pun.

Gambaran Umum

Untuk berkontribusi pada dokumentasi di Microsoft Learn, Anda dapat membuat dan mengedit file Markdown secara lokal dengan mengkloning repositori dokumentasi yang sesuai. Microsoft mengharuskan Anda untuk membuat fork repositori yang sesuai ke akun GitHub Anda sendiri sehingga Anda memiliki izin baca/tulis untuk menyimpan perubahan yang Anda usulkan. Kemudian, Anda menggunakan permintaan pull (PR) untuk menggabungkan perubahan ke dalam repositori bersama pusat baca-saja.

Repositori Microsoft disebut sebagai repositori hulu. Dengan menggunakan tindakan fork dalam antarmuka pengguna GitHub, pengguna membuat fork repositori Microsoft ke akun GitHub mereka sendiri. Fork ini disebut sebagai Asal. Dengan menggunakan kloning git, pengguna mengkloning Origin ke komputer lokal mereka. Terakhir, pengguna menggunakan git remote add upstream untuk menyambungkan kloning lokal mereka kembali ke repositori upstream Microsoft.

Menentukan repositori

Dokumentasi yang dihosting di Microsoft Learn berada di beberapa repositori di GitHub.

1. Jika Anda tidak yakin repositori mana yang berada di artikel, kunjungi artikel menggunakan browser web Anda. Pilih tautan Edit (ikon pensil) di sudut kanan atas artikel.

   

2. Tindakan ini membawa Anda ke file sumber di GitHub. Nama repositori ditampilkan di sudut kiri atas halaman.

   

   Berikut adalah beberapa repositori populer yang tersedia untuk kontribusi publik:

   • Konten Komunitas Microsoft Learn https://github.com/MicrosoftDocs/community-content/
   • Dokumentasi Azure https://github.com/MicrosoftDocs/azure-docs
   • Dokumentasi SQL Server https://github.com/MicrosoftDocs/sql-docs
   • Dokumentasi Visual Studio https://github.com/MicrosoftDocs/visualstudio-docs
   • Dokumentasi .NET https://github.com/dotnet/docs
   • Dokumentasi Azure .NET SDK https://github.com/azure/azure-docs-sdk-dotnet
   • Dokumentasi ConfigMgr https://github.com/MicrosoftDocs/SCCMdocs

Fork repositori

Setelah Anda mengidentifikasi repositori yang benar, langkah selanjutnya adalah membuat fork repositori ke akun GitHub Anda sendiri.

Untuk membuat fork repositori berarti membuat salinannya di akun GitHub Anda. Fork pribadi diperlukan karena semua repositori dokumentasi Microsoft menyediakan akses baca-saja, tetapi fork Anda memberi Anda akses tulis untuk membuat perubahan Anda. Fork memungkinkan Anda membuka PR dari fork Anda ke repositori Microsoft.

1. Dari halaman GitHub repositori utama, pilih tombol Fork di sudut kanan atas.

   

2. Di layar Buat fork baru, pastikan Pemilik diatur ke nama pengguna Anda dan salin cabang utama hanya dicentang. Secara opsional, ubah bidang Nama repositori dan Deskripsi .

   

Mengklon repositori

Mengkloning berarti membuat salinan repositori di komputer lokal Anda.

Peringatan

1. JANGAN mengkloning repositori lokal ke folder yang disinkronkan OneDrive. Saat memilih folder tempat Anda akan mengkloning repositori, hindari folder yang disinkronkan dengan OneDrive (misalnya, folder Dokumen Anda). OneDrive dapat menyebabkan konflik penggabungan yang tidak diinginkan saat Anda menggabungkan perubahan Anda kembali ke cabang utama. Sebaliknya, yang terbaik adalah membuat jalur file singkat di drive Anda C:\ (misalnya, C:\GitHub).

2. Git di Windows: Aktifkan nama jalur panjang. Secara default, Git untuk Windows menonaktifkan dukungan untuk jalur file panjang, yang mencegah file apa pun dengan jalur tujuan lebih dari 255 karakter dikloning. Aktifkan jalur file panjang untuk menghindari masalah ini dengan menjalankan perintah berikut sebagai administrator:
   git config --global core.longpaths true

1. Buat GitHub folder di komputer lokal Anda. Misalnya, C:\GitHub. (Jangan klon ke folder yang disinkronkan OneDrive.)

2. Di browser, buka GitHub.com dan masuk.

3. Di GitHub di kanan atas, dari menu drop-down profil Anda, pilih Repositori Anda. Halaman repositori muncul dengan daftar repositori fork Anda.

4. Pilih repositori yang ingin Anda kloning. Halaman repositori fork Anda muncul.

   Pastikan Anda berada di halaman repositori untuk fork Anda , bukan halaman untuk repositori produksi. Anda dapat mengonfirmasi bahwa repositori tempat Anda berada di fork Anda dengan memeriksa URL: repositori tersebut akan menampilkan nama pengguna GitHub Anda, bukan organisasi Microsoft (misalnya, https://github.com/nancydavolio/azure-docs dan TIDAKhttps://github.com/MicrosoftDocs/azure-docs). Selain itu, Anda akan melihat nama Anda di sudut kiri atas, dan Anda akan melihat catatan yang bertuliskan fork diikuti dengan nama repositori utama.

   

5. Pilih tab <> Kode di kiri atas halaman.

6. Di sisi kanan, dari menu drop-down Kode , salin URL di bawah opsi HTTPS .

   

Penting

Anda menyalin URL kloning melalui antarmuka pengguna GitHub. Langkah-langkah lainnya harus dilakukan di Terminal Visual Studio Code.

Untuk mengkloning dari Visual Studio Code

1. Buka Visual Studio Code.

2. Dari menu navigasi atas, pilih Tampilkan lalu pilih Terminal. Tampilan terminal muncul di bagian bawah layar Visual Studio Code.

3. Dalam tampilan Terminal, jalankan perintah untuk mengubah direktori (cd) ke GitHub folder yang Anda buat untuk repositori pada drive Anda di Langkah 1 di bagian Kloning repositori.

   Contoh:

    cd C:\GitHub
   

   Jika Anda mendapatkan kesalahan, Anda mungkin harus mengubah direktori satu folder sekaligus.

4. Jalankan perintah berikut untuk mengkloning repositori:

   git clone <paste the clone URL you copied via the GitHub UI>
   

   Misalnya:

   git clone https://github.com/nancydavolio/azure-docs.git
   

5. Ketika diminta untuk mengautentikasi melalui browser, pilih tombol "Masuk dengan browser Anda" dan selesaikan prosesnya. Pastikan untuk mengunduh versi terbaru Git, yang mendukung autentikasi melalui fungsionalitas browser. Jika Anda memilih untuk menggunakan token akses pribadi GitHub, Anda dapat membuat satu instruksi berikut: Membuat token akses pribadi.

   Perintah kloning mengunduh file repositori dari fork Anda ke folder baru di lokasi yang Anda pilih di Langkah 3. Folder baru dibuat di dalam folder saat ini. Mungkin perlu waktu beberapa menit, tergantung pada ukuran repositori. Anda dapat menjelajahi folder untuk melihat struktur setelah selesai.

Menyiapkan jarak jauh

Setelah mengkloning repositori, siapkan koneksi jarak jauh baca-saja ke repositori utama bernama upstream. Remote adalah alias yang merujuk ke repositori jarak jauh. Asal mengacu pada fork Anda, dan upstram mengacu pada repositori produksi. Git secara otomatis membuat origin remote saat Anda menjalankan clone perintah. Anda menggunakan URL upstream untuk menjaga repositori lokal Anda tetap sinkron dengan perubahan terbaru yang dibuat oleh orang lain.

Jalankan perintah berikut di Git Bash atau Vs Code Terminal.

1. Ubah direktori (cd) ke folder repositori yang clone dibuat perintah. Misalnya:

   cd repo-name
   

2. Jalankan perintah berikut untuk menambahkan nama upstream jarak jauh yang menunjuk ke repositori produksi. Misalnya, upstream URL repositori https://github.com/MicrosoftDocs/azure-docs.git bukan https://github.com/nancydavolio/azure-docs.git.

   git remote add upstream <the clone URL of the main repo>
   

   Misalnya:

   git remote add upstream https://github.com/MicrosoftDocs/azure-docs.git
   

3. Jalankan perintah berikut untuk memastikan jarak jauh Anda benar:

   git remote -v
   

   Contoh output:

   origin  https://github.com/nancydavolio/azure-docs.git (fetch)
   origin  https://github.com/nancydavolio/azure-docs.git (push)
   upstream        https://github.com/MicrosoftDocs/azure-docs.git (fetch)
   upstream        https://github.com/MicrosoftDocs/azure-docs.git (push)
   

4. Jika Anda membuat kesalahan, hapus jarak jauh dan ulangi langkah untuk menambahkannya. Untuk menghapus upstream, jalankan perintah :

   git remote remove upstream
   

Langkah berikutnya

• Sekarang setelah Anda menyiapkan klon lokal Anda, saatnya untuk membuat perubahan besar.