Bagikan melalui

Menerbitkan repositori Git ke wiki

Layanan Azure DevOps | Azure DevOps Server | Azure DevOps Server 2022

Anda dapat menerbitkan konten yang sudah Anda pertahankan di repositori Git ke wiki Azure DevOps. Repositori Anda mungkin berisi file untuk kit pengembangan perangkat lunak (SDK), dokumentasi produk, konten README, dan sebagainya. Anda juga dapat menerbitkan beberapa wiki untuk satu proyek tim.

Ketika Anda menerbitkan file Markdown (.md) Anda ke wiki, Anda mendapatkan beberapa manfaat:

  • Menata konten ke dalam struktur urutan halaman terkelola
  • 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 Wiki yang disediakan versus kode yang diterbitkan sebagai wiki.

Artikel ini menjelaskan cara menambahkan dan mengedit konten yang diterbitkan ke wiki dengan menggunakan portal web Azure DevOps dan Azure DevOps CLI. Anda juga dapat bekerja secara offline dan memperbarui konten wiki Anda dengan cara yang sama seperti Anda berkolaborasi pada kode dalam repositori Git. Untuk informasi selengkapnya, lihat Memperbarui halaman wiki secara offline.

Prasyarat

Kategori Persyaratan
Akses proyek Anggota proyek tempat wiki berada. Anda dapat meminta akses dari administrator proyek Anda, sesuai kebutuhan.
Izin Anggota grup Kontributor .
Repositori Git Repositori Git yang ditentukan dalam proyek tim Anda. Idealnya, repositori berisi setidaknya satu file Markdown yang ingin Anda terbitkan ke wiki Anda. Untuk informasi selengkapnya, lihat Membuat repositori Git baru di proyek Anda.

Buka wiki

Sambungkan ke proyek Azure DevOps Anda dengan menggunakan browser web yang didukung dan pilih Wiki:

Cuplikan layar wiki terbuka di browser dan memperlihatkan halaman gambaran umum wiki.

Jika Anda perlu mengalihkan proyek tim, pilih Azure DevOps untuk menelusuri semua proyek dan tim tim.

Menerbitkan repositori Git ke wiki

Bagian ini menjelaskan cara menerbitkan repositori Git Anda ke wiki. Anda dapat bekerja langsung dengan UI Azure DevOps di browser atau menggunakan Azure DevOps CLI.

Untuk menerbitkan file Markdown di repositori Git Anda ke wiki, ikuti langkah-langkah berikut:

  1. Dari halaman arahan Wiki , pilih Terbitkan kode sebagai wiki:

    Cuplikan layar yang memperlihatkan cara memilih opsi Terbitkan kode sebagai wiki di Azure DevOps.

    • Jika Anda tidak melihat opsi Terbitkan kode sebagai wiki , Anda mungkin perlu terlebih dahulu menentukan repositori Git untuk proyek Anda. Ikuti instruksi dalam Membuat repositori Git baru, refresh halaman Wiki , lalu kembali ke prosedur ini.

    • Jika Anda sudah memiliki wiki proyek tim, Anda dapat memperluas menu dropdown proyek dan memilih Terbitkan wiki kode:

      Cuplikan layar yang memperlihatkan cara memilih opsi Terbitkan kode sebagai wiki untuk proyek.

  2. Dalam dialog Terbitkan kode sebagai wiki , pilih repositori, cabang, dan folder yang berisi file Markdown. Repositori Git harus berada dalam proyek tim. Jika Anda ingin menerbitkan semua file Markdown di repositori ke wiki Anda, pilih akar repositori (/) sebagai folder:

    Cuplikan layar yang memperlihatkan cara mengonfigurasi wiki kode baru dalam dialog Terbitkan kode sebagai wiki.

  3. Masukkan nama untuk repositori wiki baru dan pilih Terbitkan. Repositori wiki dilengkapi dengan file dan folder Markdown yang terdapat dalam repositori pilihan Anda.

    Gambar berikut menunjukkan repositori yang diterbitkan untuk file yang terkandung dalam repositori azure-docs-sdk-node yang dipilih pada langkah sebelumnya:

    Cuplikan layar yang memperlihatkan wiki yang diterbitkan yang dibuat dari file Markdown dalam repositori Git.

    Wiki kode menampilkan daftar isi (TOC):

    • Judul TOC berasal dari nama file Markdown.
    • File Markdown (.md) di repositori/cabang/folder tercantum dalam urutan alfabet.
    • Halaman induk dibuat untuk setiap subfolder yang ditentukan dalam folder yang diterbitkan, meskipun folder tidak berisi file Markdown apa pun.

    Gambar berikut menunjukkan konten TOC untuk repositori azure-docs-sdk-node:

    Cuplikan layar daftar isi untuk wiki kode yang telah diterbitkan.

Cabang repositori Git dipetakan ke wiki

Kepala cabang repositori Git dipetakan ke wiki kode yang diterbitkan. Setiap perubahan yang dilakukan dalam cabang dan folder yang dipilih secara otomatis tercermin dalam wiki kode yang diterbitkan. 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.

Mengedit, mengganti nama, atau menghapus halaman

Di portal web Azure DevOps, Anda dapat mengedit, mengganti nama, atau menghapus halaman wiki:

  1. Di proyek Anda, pilih Repos>Files atau Code Files>.

  2. Dalam daftar file, pilih halaman yang ingin Anda kerjakan.

  3. Pilih Opsi lainnya untuk file, lalu pilih tindakan:

    Cuplikan layar yang memperlihatkan menu Opsi lainnya untuk file wiki yang menyertakan tindakan edit, ganti nama, dan hapus.

Catatan

Anda dapat mengelola repositori wiki dengan cara yang sama seperti Anda mengelola repositori Git lainnya dengan menentukan kebijakan cabang pada cabang yang Anda pilih untuk diterbitkan ke wiki. Jika Anda tidak menentukan kebijakan cabang, Anda juga dapat membuat perubahan dan mendorongnya langsung ke cabang dari portal web Anda atau dari klien.

Bagian berikut ini menjelaskan cara menyelesaikan tindakan secara lebih rinci.

Mengedit halaman

Saat Anda mengedit file, gunakan tautan 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.

  • Setelah selesai, tambahkan komentar tentang pembaruan Anda, lalu pilih Terapkan:

    Cuplikan layar dialog Komit untuk menambahkan perubahan Anda ke repositori wiki Anda.

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

    Cuplikan layar yang memperlihatkan tautan untuk membuat permintaan pull.

Petunjuk / Saran

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

Mengganti nama halaman

Semua halaman yang ingin Anda tampilkan di WIKI TOC harus menggunakan tipe file Markdown (.md). Anda dapat menggunakan tindakan Ganti Nama untuk mengganti nama file, termasuk mengubah ekstensi file.

Contoh berikut mengganti nama file new-home-page.md menjadi New-Home-Page.md. Halaman terkait ditampilkan di wiki TOC dengan label , "Halaman Beranda Baru."

Cuplikan layar yang memperlihatkan cara mengganti nama file pada dialog Ganti Nama Komit.

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

Menghapus halaman

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

Menambahkan halaman atau beberapa halaman

Ada beberapa cara untuk menambahkan halaman ke wiki yang diterbitkan:

  • Menambahkan file ke folder akar wiki atau subfolder apa pun
  • Mengunggah file ke folder akar wiki atau subfolder apa pun
  • Menambahkan atau memperbarui file .order apa pun untuk menentukan urutan halaman di wiki TOC

Untuk setiap pembaruan, Anda perlu menerapkan perubahan Anda pada repositori wiki. Kemudian, refresh wiki Anda untuk repositori yang telah diterbitkan untuk meninjau perubahan.

Menambahkan halaman dari portal web

Untuk menambahkan halaman ke wiki yang diterbitkan, ikuti langkah-langkah berikut:

  1. Di portal web Azure DevOps, buka Repos>File atauFile> untuk repositori yang diterbitkan.

  2. Pilih Opsi lainnya untuk repositori, lalu pilihFile>:

    Cuplikan layar yang memperlihatkan cara menambahkan file ke repositori wiki yang diterbitkan di portal web Azure DevOps.

  3. Dalam dialog, masukkan nama untuk file baru yang menyertakan jenis file Markdown (.md).

    Nama file harus sesuai dengan judul halaman yang ingin Anda tampilkan di wiki TOC. Ganti spasi apa pun di judul halaman dengan tanda hubung (-) dalam nama file. Judul halaman sensitif terhadap huruf besar/kecil dan harus unik dalam folder. Judul harus 235 karakter atau kurang. Untuk informasi selengkapnya, lihat Pembatasan penamaan judul halaman.

    Contoh berikut menambahkan file bernama Page-4.md yang ditampilkan di WIKI TOC dengan judul halaman "Halaman 4."

    Cuplikan layar yang memperlihatkan cara menentukan nama file untuk file baru.

    Pilih Buat.

  4. Saat halaman muncul di daftar file, pilih halaman lalu pilih Edit. Masukkan konten untuk halaman. Untuk informasi selengkapnya, lihat Panduan sintaks untuk file Markdown, widget, wiki, dan komentar permintaan pull.

  5. Setelah selesai, tambahkan halaman baru ke repositori yang diterbitkan dengan memilih Terapkan.

Mengunggah file ke folder

Anda juga dapat mengunggah file ke folder di wiki yang diterbitkan. Opsi ini berguna saat Anda memiliki konten yang sudah ada yang ingin Anda tambahkan.

  1. Di portal web Azure DevOps, buka Repos>File atauFile> untuk repositori yang diterbitkan.

  2. Pilih Opsi lainnya untuk repositori, lalu pilih Unggah file:

    Cuplikan layar yang memperlihatkan cara mengunggah file yang ada ke repositori wiki yang diterbitkan di portal web Azure DevOps.

  3. Dalam dialog Terapkan , pilih folder dan file yang ingin Anda unggah:

    Cuplikan layar yang memperlihatkan cara memilih folder dan file yang ingin Anda unggah dalam dialog Terapkan.

  4. Setelah selesai, unggah file ke repositori yang diterbitkan dengan memilih Terapkan.

Menambahkan halaman yang memiliki sub-halaman

Jika Anda ingin halaman di wiki Anda memiliki sub-halaman, Anda memerlukan file dan folder Markdown yang memiliki nama yang sama. File dan folder harus berada di folder wiki yang sama.

  1. Buat file Markdown baru dengan mengikuti langkah-langkah di Menambahkan halaman dari portal web.

  2. Untuk membuat folder terkait, pilih Opsi lainnya untuk repositori, lalu pilihFolder>.

  3. Dalam dialog Folder Baru , masukkan nama folder, yang harus identik dengan nama file Markdown:

    Cuplikan layar yang memperlihatkan cara menentukan folder baru untuk berfungsi sebagai halaman dengan sub-halaman di wiki TOC.

    Pilih Buat.

  4. Di daftar file wiki, pilih folder baru. Tambahkan satu atau beberapa file sebagai sub-halaman ke folder.

Menambahkan atau memperbarui file .order

Setelah Anda menambahkan file atau folder ke repositori yang diterbitkan, langkah terakhir adalah menambahkan atau memperbarui file .order untuk folder baru atau yang diperbarui. Perbarui urutan halaman untuk memastikan file dan folder baru ditampilkan di wiki TOC seperti yang diharapkan.

Untuk informasi selengkapnya, lihat Mengubah urutan halaman, menambahkan, atau memperbarui file .order. File apa pun yang tidak tercantum dalam file .order ditambahkan ke akhir daftar alfabet dalam urutan halaman.

Ubah urutan halaman dengan file .order

File .order di akar wiki menentukan urutan tampilan untuk halaman di tingkat akar. File adalah daftar teks biasa nama halaman yang sesuai dengan file Markdown di folder, seperti Selamat Datang, dukungan, rel-2025, dan sebagainya. Setiap folder dalam wiki juga memiliki file .order yang menentukan urutan halaman untuk folder tersebut.

Ikuti langkah-langkah ini untuk menyiapkan file urutan pesanan untuk folder:

  1. Di halaman File Kode>, pilih File baru. Beri nama file .order.

  2. Edit konten file untuk menentukan urutan tampilan untuk file Markdown di folder.

    Tambahkan entri yang sesuai untuk setiap file halaman di folder yang ingin Anda buat terlihat oleh pengguna wiki.

    Judul halaman peka huruf besar/kecil. Teks entri harus cocok dengan judul halaman dan huruf besar/kecil yang digunakan dalam nama file, tetapi jangan sertakan jenis file Markdown (.md).

Contoh berikut menunjukkan file .order untuk folder dengan lima file:

readme-version-9
Project-Overview
Get-Started
Submit-a-pull-request
team-contacts

Mengatur halaman beranda wiki

Saat Anda memilih Wiki di portal web Azure DevOps, halaman beranda untuk wiki Anda terbuka.

Secara default, halaman pertama yang Anda tambahkan saat membuat wiki diatur sebagai halaman beranda wiki. Ketika wiki Anda memiliki beberapa halaman, file pertama dalam urutan alfabet diatur sebagai halaman beranda.

Anda dapat menentukan halaman mana yang akan digunakan sebagai halaman beranda dengan mengatur urutan halaman dalam file .order di akar wiki. Tempatkan nama halaman utama di baris teratas dalam berkas root .order

Wiki-Welcome
Project-Overview
Get-Started
Submit-a-pull-request
team-contacts
readme-version-9

Ubah folder menjadi halaman wiki

Anda dapat menampilkan folder di repositori Anda sebagai halaman di wiki Anda. Proses ini dikenal sebagai mempromosikan folder ke halaman.

Untuk skenario ini, Anda memerlukan konfigurasi berikut:

  • File Markdown (.md) di wiki Anda yang memiliki nama yang sama dengan folder .

  • File dan folder Markdown harus serekan di lokasi yang sama di daftar file wiki Anda.

Contoh berikut menunjukkan file folder dan Markdown (.md) yang keduanya bernama Uji. Kehadiran rekan-rekan dengan nama yang sama di lokasi yang sama membuat halaman dengan nama yang sama dalam urutan wiki:

Cuplikan layar yang memperlihatkan folder dan file Markdown bernama Uji, yang membuat halaman bernama Uji dalam urutan wiki.

Pilih versi wiki

Jika wiki Anda memiliki beberapa versi yang diterbitkan, versi terbaru ditampilkan secara default.

Anda dapat memilih versi wiki yang berbeda dengan memperluas daftar dropdown cabang dan memilih versi yang akan ditampilkan:

Cuplikan layar yang memperlihatkan cara memilih versi wiki kode tertentu dari menu dropdown wiki.

Membatalkan penerbitan wiki kode

Jika Anda tidak lagi ingin repositori Git diterbitkan sebagai wiki, Anda dapat membatalkan penerbitan wiki.

Peringatan

Tidak mempublikasikan wiki berarti tidak mempublikasikan seluruh wiki kode, termasuk semua versi repositori kode yang telah diterbitkan.

  1. Di daftar wiki, pilih wiki yang ingin Anda batalkan penerbitannya, pilih Opsi lainnya (...) >Batal terbitkan wiki:

    Cuplikan layar yang memperlihatkan cara memilih opsi Batal terbitkan untuk wiki dari menu dropdown Opsi lainnya.

    Setelah Anda memilih tindakan Batalkan penerbitan , dialog akan terbuka untuk konfirmasi.

  2. Dalam dialog konfirmasi, pilih Batal terbitkan:

    Cuplikan layar yang memperlihatkan cara membatalkan penerbitan wiki.

Konten terkait

  • Last updated on