Tentang wiki, READMEs, dan Markdown

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

Untuk mendukung tim atau kontributor Anda ke proyek Anda, gunakan Markdown untuk menambahkan pemformatan, tabel, dan gambar yang kaya ke proyek tim Anda. Anda dapat menggunakan format Markdown dalam wiki proyek tim, konten yang Anda tambahkan ke dasbor, file README proyek tim Anda, atau file README repositori lainnya.

Wiki

Gunakan wiki proyek tim Anda untuk berbagi informasi dengan anggota tim lain. Saat Anda menyediakan wiki dari awal, repositori Git baru menyimpan file, gambar, lampiran, dan urutan halaman Markdown Anda. Wiki ini mendukung pengeditan konten dan strukturnya secara kolaboratif.

Fitur berikut ini didukung untuk wiki proyek tim.

Memprovisikan atau membuat wiki

• Membuat wiki untuk proyek tim Anda
• Menerbitkan kode sebagai wiki

Bekerja dengan konten wiki

• Menambahkan dan mengedit halaman wiki
• Lihat riwayat halaman wiki dan kembalikan
• Mengkloning dan memperbarui konten wiki secara offline
• Menggunakan pintasan keyboard wiki
• Memfilter atau mencetak konten^{wiki 1}

Catatan

Fitur cetak mungkin tidak tersedia dari browser web Firefox.

Memformat konten wiki

• Format markdown
• Tag HTML
• Menyisipkan dan mengubah ukuran gambar
• Menautkan ke item kerja menggunakan #
• Lampirkan file
• Notasi dan karakter matematika
• Daftar isi (TOC) untuk halaman wiki

Menerbitkan repositori Git yang ada ke wiki

Banyak tim mendokumenkan kode mereka menggunakan Markdown dan memeriksa file-file ini bersama dengan kode. Sementara Git mendukung pemeliharaan dan peninjauan dokumentasi tersebut bersama dengan permintaan pull standar, file tersebut memberikan beberapa tantangan kepada konsumen konten.

• Pembaca harus sering menyaring banyak file dan folder untuk menemukan konten yang menarik.
• Konten tidak memiliki organisasi dan struktur. Tidak ada hierarki halaman yang melekat untuk mendukung pembaca.
• Penerapan versi konten tidak didukung.
• Mencari melalui konten bergantung pada pencarian kode daripada pengalaman pencarian yang dioptimalkan untuk mencari konten.

Dengan kode penerbitan sebagai fitur wiki, Anda dapat menerbitkan satu atau beberapa repositori Git yang ditentukan dalam proyek tim Anda ke wiki. Fitur ini menyediakan cara untuk mempertahankan konten Anda bersama basis kode Anda, dan memungkinkan Anda menerbitkan dan memperbarui konten Anda secara selektif ke wiki.

Ada perbedaan signifikan antara cara Anda mengelola konten untuk wiki yang Anda provisikan untuk proyek tim versus halaman wiki yang Anda terbitkan dari repositori Git. Untuk detailnya, lihat Menerbitkan repositori Git ke wiki.

Markdown

Markdown memudahkan untuk memformat teks dan menyertakan gambar. Anda juga dapat menautkan ke dokumen dalam halaman proyek, file README, dasbor, dan permintaan pull. Anda dapat memberikan panduan kepada tim Anda di tempat-tempat berikut menggunakan Markdown:

• Wiki proyek tim
• Menerbitkan kode sebagai wiki
• Menambahkan Markdown ke dasbor
• Halaman proyek atau halaman Selamat Datang
• File README repositori
• Permintaan pull

Untuk sintaks yang didukung, lihat Menggunakan Markdown di Azure DevOps.

READMEs

Anda dapat menentukan file README atau beberapa file untuk setiap repositori atau proyek tim. Tulis README Anda di Markdown alih-alih teks biasa.

Gunakan halaman README untuk mengorientasikan kontributor agar berfungsi dalam proyek Anda. Pertimbangkan untuk menambahkan panduan berikut:

• Fokus proyek
• Prasyarat
• Menyiapkan lingkungan
• Tips untuk menyelesaikan berbagai hal dalam proyek
• Tujuan atau penggunaan file tertentu
• Istilah dan akronim khusus proyek
• Panduan alur kerja tentang menerapkan atau mengunggah perubahan dan menambahkan cabang
• Sponsor atau kontak proyek

Berikut adalah beberapa READMEs hebat yang menggunakan format ini dan berbicara dengan semua audiens untuk referensi dan inspirasi:

• Inti ASP.NET
• Visual Studio Code
• Chakra Core