Buat wiki untuk proyek Anda

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

Di Azure DevOps, setiap proyek tim memiliki wiki. Anda dapat menggunakan wiki untuk berbagi informasi dengan tim Anda dan mendukung kontribusi proyek. Wiki didukung oleh repositori Git di backend. Artikel ini menjelaskan cara membuka wiki proyek dan membuat repositori Git.

Saat Anda membuat proyek tim, repositori Wiki Git tidak dibuat secara default. Anda dapat membuat repositori untuk menyimpan file Markdown wiki Anda, atau menerbitkan file Markdown yang ada dari repositori Git ke wiki.

Prasyarat

Kategori	Persyaratan
Akses proek	Anggota proyek tempat wiki berada. Jika Anda tidak memiliki akses, mintalah dari administrator proyek Anda. Siapa pun yang memiliki akses ke proyek tim dapat melihat wiki, termasuk Pemangku Kepentingan.
Izin	- Untuk menambahkan atau mengedit halaman wiki: Anggota grup Kontributor. - Untuk menerbitkan kode sebagai wiki: Buat Izin Repositori. Secara default, izin ini diatur untuk anggota grup Administrator Proyek.
Tingkat akses	Setidaknya Akses Dasar.

Buka Wiki

Anda dapat membuka dan melihat halaman wiki untuk proyek tim Anda dari Azure DevOps di browser atau menggunakan Azure DevOps CLI.

Peramban

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

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

Azure DevOps CLI

Anda dapat melihat dan membuka halaman wiki untuk proyek dengan menggunakan az devops wiki show perintah :

az devops wiki show --wiki
                      [--open]
                      [--project]
                      [--subscription]

Untuk informasi selengkapnya, lihat Mulai menggunakan Azure DevOps CLI.

Parameter dasar

Parameter berikut tersedia untuk wiki show perintah:

Pengaturan	Diperlukan	Deskripsi
--wiki	Ya	Nama atau ID wiki.
--open	Tidak.	Buka halaman wiki di browser web Anda.
--project -p	Tidak.	Nama atau ID proyek.
--subscription	Tidak.	Nama atau ID langganan. Anda dapat mengonfigurasi langganan default dengan az account set -s NAME_OR_ID perintah .

Untuk informasi selengkapnya, lihat referensi perintah Azure DevOps CLI.

Contoh: Menampilkan wiki proyek

Contoh berikut menunjukkan cara membuka wiki bernama "MyProjectwiki":

az devops wiki show --wiki MyProjectwiki --open

Menampilkan halaman wiki

Anda dapat melihat konten halaman tertentu dengan menggunakan perintah Azure DevOps CLI az devops wiki show :

az devops wiki page show --path
                         --wiki
                         [--include-content]
                         [--open]
                         [--project]
                         [--subscription]
                         [--version]

Parameter lainnya

Tabel berikut ini mencantumkanwiki show lebih banyak parameter untuk perintah saat Anda ingin menampilkan halaman tertentu:

Pengaturan	Diperlukan	Deskripsi
--path	Ya	Jalur yang sepenuhnya memenuhi syarat untuk halaman wiki.
--include-content	Tidak.	Perlihatkan konten halaman lengkap bersama dengan metadata halaman.
--version -v	Tidak.	Versi halaman wiki yang berhubungan dengan nilai tag entitas ETag.

Untuk informasi selengkapnya, lihat referensi perintah Azure DevOps CLI.

Contoh: Menampilkan halaman tertentu

Contoh berikut menunjukkan cara mendapatkan konten untuk halaman "Memulai" wiki "MyProjectwiki":

az devops wiki page show --path 'Get Started' --wiki 'MyProjectwiki' --content "Hello World"

Membuat repositori Wiki Git

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

Peramban

Di browser, Anda dapat membuat repositori Git baru untuk menyimpan halaman wiki dan artefak terkait. Dari halaman arahan Wiki , pilih Buat wiki proyek. Bahkan jika Anda menggunakan Team Foundation Version Control (TFVC) untuk kontrol sumber, Anda dapat membuat wiki dengan repositori Git.

Jika Anda tidak memiliki izin yang diperlukan untuk membuat repositori Wiki Git atau Anda tidak dapat mengakses wiki yang ada, Anda akan melihat pesan berikut:

Pengguna dengan akses tingkat administrator Proyek dapat membuat repositori Wiki Git. Pengguna dengan akses Pemangku Kepentingan tidak dapat membuat wiki karena mereka tidak memiliki izin untuk bekerja di bagian Repos atau Kode proyek.

Nama untuk repositori wiki Anda didasarkan pada nama proyek Anda. Konvensinya adalah <ProjectName>.wiki. Jika nama proyek tim Anda adalah Contoso nama repositori wiki Anda adalah Contoso.wiki.

Petunjuk / Saran

Anda dapat membuat beberapa wiki untuk satu proyek dengan menerbitkan kode Anda sebagai wiki.

Mengakses repositori wiki Anda

Repositori Git untuk wiki Anda (ProjectName.wiki) tidak disertakan dalam daftar dropdown repositori di bagian Repos atau Kode proyek Anda. Repositori wiki juga tidak tercantum di halaman Repositori Pengaturan > Proyek atau Kontrol Versi . Sebagai gantinya, Anda dapat mengakses repositori wiki Anda dari halaman Repos>Files untuk wiki Anda.

1. Buat URL untuk halaman Repos>Files . Dalam URL berikut, ganti nama server, organisasi, proyek, dan wiki Anda pada bagian <Placeholder> mana pun.

   https://dev.azure.com/<Organization>/<ProjectName>/_git/<WikiName>

2. Tempelkan URL ke browser dan buka halaman File untuk wiki Anda.

3. Pada halaman Repos>Files , temukan nama repositori wiki Anda dan pilih Opsi lainnya (...) >Kloning.

   

   Opsi Kloning membuka dialog yang menyertakan URL untuk repositori wiki Anda.

4. Dalam dialog, pilih HTTP lalu pilih ikon Salin (halaman ganda):

   

   URL disalin ke clipboard Anda.

   Tutup dialog.

5. Untuk mengakses repositori wiki, tempelkan URL yang disalin ke browser.

Azure DevOps CLI

Anda dapat membuat wiki dengan perintah az devops wiki create :

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

Untuk informasi selengkapnya, lihat Mulai menggunakan Azure DevOps CLI.

Catatan

Jika Anda ingin membuat lebih dari satu wiki, Anda perlu menerbitkan kode proyek Anda sebagai wiki. Anda dapat menyiapkan beberapa repositori wiki untuk satu proyek.

Parameter

Parameter berikut tersedia untuk wiki create perintah . Parameter type menentukan jenis wiki yang akan dibuat: Wiki proyek (projectwiki) atau Terbitkan kode sebagai wiki (codewiki).

Pengaturan	Diperlukan	Deskripsi
mapped-path	Ya (codewiki)	Jalur yang dipetakan untuk wiki. Anda dapat menentukan tanda garis miring terbalik (/) untuk memublikasikan dari akar repositori wiki.
name	Ya (codewiki)	Nama untuk wiki. Untuk jenisnya projectwiki , ketika tidak ada nama yang ditentukan, nama wiki adalah TeamProjectName.wiki.
org	Mungkin	URL organisasi Azure DevOps. Anda dapat mengonfigurasi organisasi default dengan az devops configure -d organization=ORG_URL perintah . Catatan: Saat organisasi tidak dikonfigurasi secara default atau diambil dengan menggunakan perintah , parameter tersebut menjadi wajib. Contoh: --org https://dev.azure.com/<OrganizationName>/.
project	Mungkin	Nama atau ID proyek. Anda dapat mengonfigurasi proyek default dengan menggunakan az devops configure -d project=NAME_OR_ID perintah . Catatan: Saat proyek tidak dikonfigurasi secara default atau diambil dengan menggunakan perintahgit config, parameter diperlukan.
repository	Ya (codewiki)	Nama atau ID repositori Git untuk menerbitkan wiki.
type	Tidak.	Jenis wiki yang akan dibuat: Wiki proyek (projectwiki) atau Terbitkan kode sebagai wiki (codewiki). Defaultnya adalah projectwiki.
version	Ya (codewiki)	Nama cabang repositori Git untuk menerbitkan wiki kode.

Contoh: Membuat wiki proyek

Perintah berikut membuat wiki proyek bernama "Fabrikam Fiber" dan menunjukkan output dalam format tabel:

az devops wiki create --name "Fabrikam Fiber" --output table

ID                                    Name                 Type
------------------------------------  -------------------  -----------
7edcc35b-89be-465e-855e-377ba8660af7  Fabrikam Fiber.wiki  projectWiki

Langkah selanjutnya

Menambahkan dan mengedit halaman wiki