Menerbitkan repositori Git ke wiki

Layanan Azure DevOps | Azure DevOps Server 2022 - Azure DevOps Server 2019

Anda dapat menerbitkan konten yang sudah Anda pertahankan di repositori Git ke wiki. Misalnya, konten ini dapat berupa dukungan kit pengembangan perangkat lunak (SDK), dokumentasi produk, atau file README. Anda juga dapat menerbitkan beberapa wiki dalam satu proyek tim.

Saat menerbitkan file Markdown ke wiki, Anda mendapatkan manfaat berikut:

• Menata konten ke dalam struktur halaman hierarkis
• Menelusuri dan memfilter daftar isi
• Menerbitkan versi baru konten
• Mengelola konten dengan cara yang sama seperti Anda mengelola basis kode Anda
• Cari wiki dengan mudah menggunakan fitur pencarian wiki

Untuk informasi selengkapnya, lihat Kode yang disediakan vs. diterbitkan sebagai wiki.

Tip

Anda bisa menambahkan dan mengedit konten yang Anda terbitkan ke wiki menggunakan langkah-langkah dalam artikel ini. Anda juga dapat bekerja offline dan memperbarui konten wiki dengan cara yang sama seperti Anda berkolaborasi pada kode melalui repositori Git. Untuk informasi selengkapnya, lihat Memperbarui halaman wiki secara offline.

Prasyarat

• Memiliki proyek tim. Jika Anda tidak memilikinya, buat proyek sekarang.
• Aktifkan layanan Azure Repos untuk proyek Anda.
• Memiliki repositori Git yang ditentukan dalam proyek tim Anda. Idealnya, repositori ini berisi setidaknya satu file Markdown, yang ingin Anda terbitkan ke wiki Anda. Untuk informasi selengkapnya, lihat Membuat repositori Git baru di proyek Anda.
• Minta izin Berkontribusi untuk menerbitkan kode sebagai wiki. Secara default, izin ini diatur untuk anggota grup Kontributor. Siapa pun yang memiliki izin untuk berkontribusi pada repositori Git dapat menambahkan atau mengedit halaman wiki.

Buka wiki

1. Masuk ke organisasi Anda (https://dev.azure.com/{yourorganization}), buka proyek Anda, lalu pilih Wiki Gambaran Umum>.

   

Jika Anda perlu beralih proyek, pilih Azure DevOps untuk menelusuri semua proyek.

Menerbitkan repositori Git ke wiki

Browser

Lakukan langkah-langkah berikut saat Anda mempertahankan file Markdown di repositori Git yang sudah ada dan Anda ingin menerbitkannya ke wiki.

1. Pilih Terbitkan kode sebagai wiki.

   

   Catatan

   Opsi Terbitkan kode sebagai wiki tidak akan muncul jika proyek Anda tidak memiliki repositori Git yang ditentukan. Buat repositori Git baru, lalu kembalikan dan refresh halaman ini.

2. Jika Anda sudah menyediakan wiki proyek tim, pilih Terbitkan wiki kode.

   

3. Pilih repositori, cabang, dan folder yang berisi file Markdown dan masukkan nama untuk repositori wiki. Repositori Git harus berada dalam proyek tim.

   

   Tentukan akar repositori saat Anda ingin menerbitkan semua file Markdown di repositori ke wiki Anda.

4. Pilih Terbitkan. Wiki diisi ulang dengan file dan folder Markdown yang disertakan dalam repositori yang Anda pilih.

   Misalnya, gambar berikut menunjukkan repositori yang diterbitkan untuk file yang terkandung dalam repositori azure-docs-sdk-node yang Anda pilih di Langkah 2.

   

   Daftar isi wiki (TOC) berisi file berikut:

   • Setiap file Markdown (jenis file= .md) yang ditentukan dalam repo/cabang/folder tercantum dalam urutan alfabet, judul TOC berasal dari nama file Markdown.

   • Halaman induk untuk setiap subfolder yang ditentukan dalam folder yang diterbitkan, meskipun tidak berisi file Markdown apa pun.

     Gambar berikut menunjukkan konten repositori azure-docs-sdk-node.

     

Kepala cabang repositori Git dipetakan ke wiki. Setiap perubahan yang dilakukan dalam cabang dan folder yang dipilih secara otomatis tercermin di wiki. Tidak ada alur kerja lain yang terlibat.

Catatan

Anda dapat menerbitkan hingga 10 cabang per wiki kode yang diterbitkan.

Untuk wiki yang disediakan dengan file Markdown tambahan, Anda dapat menambahkan atau mengedit halaman dengan cara yang sama seperti Anda mempertahankan kode di repositori Git Anda.

Azure DevOps CLI

Anda dapat menerbitkan repositori Git ke wiki dengan perintah az devops wiki create . Untuk memulai, lihat Mulai menggunakan Azure DevOps CLI. Jalankan perintah ini saat Anda mempertahankan file Markdown di repositori Git yang ada dan Anda ingin menerbitkannya ke wiki.

Catatan

Anda tidak dapat menerbitkan kode sebagai wiki jika proyek Anda belum memiliki repositori Git yang sudah ditentukan. Jika perlu, buat repositori Git baru, lalu kembali ke halaman ini.

az devops wiki create [--mapped-path]
                      [--name]
                      [--org]
                      [--project]
                      [--repository]
                      [--type {codewiki, projectwiki}]
                      [--version]

Parameter

• mapped-path: Diperlukan untuk jenis.codewiki Jalur wiki baru yang dipetakan. Misalnya, Anda dapat menentukan '/' untuk diterbitkan dari akar repositori.
• name: Nama wiki baru.
• org: URL organisasi Azure DevOps. Anda dapat mengonfigurasi organisasi default menggunakan az devops configure -d organization=ORG_URLperintah . Diperlukan jika tidak dikonfigurasi sebagai default atau diambil menggunakan git config perintah . Contohnya,--org https://dev.azure.com/MyOrganizationName/.
• project: Nama atau ID proyek. Anda dapat mengonfigurasi proyek default menggunakan az devops configure -d project=NAME_OR_ID perintah . Diperlukan jika tidak dikonfigurasi sebagai default atau diambil menggunakan git config perintah .
• repository: Diperlukan untuk jenis.codewiki Nama atau ID repositori tempat menerbitkan wiki.
• type: Jenis wiki yang akan dibuat. Nilai yang diterima adalah projectwiki (default) dan codewiki.
• version: Diperlukan untuk jenis.codewiki Nama cabang repositori tempat menerbitkan wiki kode.

Contoh

Perintah berikut membuat "Wiki Baru Saya" yang codewiki diterbitkan dari repositori MyRepo . Wiki diterbitkan dalam wikis folder di main cabang dan hasilnya diperlihatkan dalam format tabel.

az devops wiki create --name "My New Wiki" --type codewiki --repository MyRepo --mapped-path /wikis --version main --output table

ID                                    Name         Type
------------------------------------  -----------  --------
77abd847-31ec-45e9-8622-a190df8e5917  My New Wiki  codewiki

Mengedit, mengganti nama, atau menghapus halaman

Lakukan langkah-langkah berikut untuk mengedit, mengganti nama, atau menghapus halaman wiki.

1. Di proyek Anda, buka File Repos> atau File Kode.>

2. Pilih halaman yang Anda inginkan, pilih Tindakan, lalu pilih operasi.

   

Catatan

Kelola repositori wiki Anda dengan cara yang sama seperti Anda mengelola repositori Git lainnya dengan menentukan kebijakan cabang di cabang yang Anda pilih untuk diterbitkan ke wiki. Namun, tanpa kebijakan apa pun yang ditentukan, Anda dapat membuat perubahan dan mendorongnya langsung ke cabang dari portal web Anda atau dari klien.

Mengedit halaman

Gunakan tautan yang tersedia dalam mode edit untuk mempratinjau perubahan Anda atau menyoroti perubahan yang dibuat dari versi sebelumnya. Untuk membuang perubahan Anda, pilih Batal. Untuk informasi selengkapnya tentang fitur Markdown yang didukung, lihat Panduan sintaks untuk penggunaan Markdown.

1. Setelah selesai, tambahkan komentar tentang pembaruan Anda, lalu pilih Terapkan.

   

   Sistem secara otomatis memberi Anda tautan untuk membuat permintaan pull. Anda dapat mengabaikan pesan ini ketika Anda langsung mengedit cabang wiki.

   

Tip

Saat Anda mengubah nama atau kasus file, perbarui .order file untuk mencerminkan perubahan. Untuk informasi selengkapnya, lihat Mengubah urutan halaman, menambahkan atau memperbarui file .order.

Mengganti nama halaman

Semua halaman yang ingin Anda munculkan di TOC harus berupa tipe .mdfile .

1. Pilih Ganti nama untuk mengganti nama file yang sesuai.

Misalnya, dalam gambar berikut, kami mengganti nama new-home-page.md menjadi New-Home-Page.md. Halaman ini muncul di TOC dengan label, "Halaman Beranda Baru."

Judul halaman peka huruf besar/kecil dan harus unik dalam folder, dan 235 karakter atau kurang. Untuk informasi selengkapnya tentang pembatasan judul lainnya, lihat Pembatasan penamaan judul halaman.

Menghapus halaman

Anda dapat menghapus file Markdown apa pun yang tidak ingin Anda munculkan di wiki dari folder yang diterbitkan. Jika Anda menyertakan file dalam .order file, hapus entrinya dari .order file. Untuk informasi selengkapnya, lihat Mengubah urutan halaman, menambahkan, atau memperbarui file .order.

Menambahkan halaman atau halaman

Anda bisa menambahkan halaman berikut ke wiki yang diterbitkan:

• Menambahkan file ke folder akar atau subfolder dari portal web
• Mengunggah file ke folder akar atau subfolder
• Menambahkan atau memperbarui .order file untuk menentukan urutan halaman di wiki TOC

Setiap pembaruan mengharuskan Anda menerapkan perubahan pada repositori. Anda kemudian dapat me-refresh wiki untuk repositori yang diterbitkan untuk meninjau perubahan.

Menambahkan halaman dari portal web

1. Dari Repos>File atau File Kode>untuk repositori yang diterbitkan, pilih Tindakan, lalu pilih File.

   

2. Masukkan nama untuk halaman, pastikan untuk menentukan .md jenis file. Nama file harus sesuai dengan judul halaman yang ingin Anda munculkan di TOC, dengan tanda hubung sebagai pengganti spasi. Tentukan judul unik 235 karakter atau kurang. Judul halaman peka huruf besar/kecil. Untuk informasi selengkapnya tentang pembatasan judul lainnya, lihat Pembatasan penamaan judul halaman.

   Misalnya, untuk menambahkan halaman yang muncul di TOC sebagai Halaman 4, tambahkan file bernama Page-4.md.

   

3. Masukkan konten halaman. Untuk informasi selengkapnya, lihat Panduan sintaks untuk file Markdown, widget, wiki, dan komentar permintaan pull.

4. Setelah selesai, pilih Terapkan.

Mengunggah file ke folder

1. Jika Anda sudah menentukan konten yang sudah ada, Anda dapat mengunggahnya ke folder. Pilih Tindakan, lalu pilih Unggah file.

   

2. Lengkapi formulir dialog Terapkan, pilih folder dan file yang ingin Anda unggah.

   

Menambahkan halaman dan sub-halaman induk

Untuk menambahkan halaman induk, pertama-tama tambahkan file Markdown di tingkat folder akar lalu tambahkan folder dengan label yang sama.

1. Untuk menambahkan folder, pilih Folder, lalu lengkapi formulir dialog Folder Baru. Tentukan setidaknya satu file yang sesuai dengan sub halaman dalam folder.

   

2. Tambahkan semua file yang Anda inginkan sebagai sub-halaman ke folder.

Menambahkan atau memperbarui file .order

Langkah terakhir saat Anda menambahkan file atau folder ke repositori wiki adalah menambahkan atau memperbarui .order file folder yang diperbarui. Tindakan ini mencerminkan urutan halaman yang ingin Anda tampilkan di TOC. Untuk detailnya, lihat Mengubah urutan halaman, menambahkan, atau memperbarui file .order. File apa pun yang tidak tercantum dalam .order file ditambahkan ke akhir daftar alfabet, karena urutannya diatur ke int.MaxValue.

Mengubah urutan halaman, menambahkan, atau memperbarui file .order

Setiap .order file menentukan urutan halaman yang terkandung dalam folder. File akar .order menentukan urutan halaman yang ditentukan pada tingkat akar. Untuk setiap folder, .order file menentukan urutan sub-halaman yang ditambahkan ke halaman induk.

1. Anda dapat menambahkan .order file dengan cara yang sama seperti Anda menambahkan file apa pun dari halaman File Kode>. Beri nama file .order.

2. Edit konten file untuk mencerminkan urutan file Markdown yang terkandung dalam folder. Setiap entri harus mencerminkan nama file tetapi tanpa .md jenis file. Judul peka huruf besar/kecil, sehingga entri harus cocok dengan kasus yang digunakan dalam nama file.

Contohnya:

README
page-2
page-3
Page-4
Misc content

Mengatur halaman beranda

Secara default, file pertama yang muncul di root dalam urutan alfabet diatur sebagai halaman beranda wiki. Saat Anda memilih Wiki di portal web, halaman beranda akan terbuka.

1. Ubah beranda dengan mengatur urutan halaman dalam file akar .order .

Misalnya, masukkan nama halaman ke baris pertama.

New home page name here
page-2
page-3
Page-4
README
Misc content

Promosikan folder ke halaman

Agar folder juga menjadi halaman, Anda memerlukan file Markdown dengan nama yang sama dengan folder, diatur sebagai saudara ke folder. Jadi, folder dan .md file dengan nama yang sama harus berbaring di samping satu sama lain.

Seperti yang ditampilkan dalam contoh berikut, Uji memiliki folder dan .md file, yang membuat hierarki di dalam pohon wiki.

Pilih versi wiki

Untuk memilih versi wiki, pilih versi dari opsi cabang dari halaman wiki.

Membatalkan penerbitan wiki kode

Jika Anda tidak lagi ingin repositori diterbitkan sebagai wiki, Anda dapat memilih untuk membatalkan penerbitannya.

Peringatan

Membatalkan penerbitan wiki membatalkan penerbitan seluruh wiki kode, yang mencakup semua versi repositori yang telah Anda terbitkan sebelumnya.

1. Pilih wiki yang ingin Anda batalkan penerbitannya, buka menu konteks, dan pilih Batal terbitkan wiki.

   

2. Konfirmasikan bahwa Anda ingin membatalkan penerbitan wiki dengan memilih Batal terbitkan.

   

Artikel terkait

• Mengikuti halaman wiki dan mendapatkan pemberitahuan
• Wiki yang diprovisikan vs. diterbitkan
• Memperbarui wiki offline
• Panduan Markdown Wiki