Wiki'ler, README'ler ve Markdown hakkında
Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019
Ekibinizi veya projenize katkıda bulunanları desteklemek için Markdown'ı kullanarak ekip projenize zengin biçimlendirme, tablolar ve resimler ekleyin. Markdown biçimini bir takım projesi wiki'sinde, panoya eklediğiniz içerikte, takım projesi BENIOKU dosyasında veya diğer depo BENİOKU dosyasında kullanabilirsiniz.
Wiki
Diğer ekip üyeleriyle bilgi paylaşmak için ekip projesi wiki’nizi kullanın. Sıfırdan wiki sağladığınızda, yeni bir Git deposu, Markdown dosyalarınızı, resimlerinizi, eklerinizi ve sayfa dizinizi depolar. Bu wiki, içeriğinin ve yapısının işbirliğine dayalı olarak düzenlenmesini destekler.
Takım projesi wiki'sinde aşağıdaki özellikler desteklenir.
Wiki sağlama veya oluşturma
Wiki içeriğiyle çalışma
- Wiki sayfalarını ekleme ve düzenleme
- Wiki sayfası geçmişini görüntüleme ve geri döndürme
- Wiki içeriğini çevrimdışı kopyalama ve güncelleştirme
- Wiki klavye kısayollarını kullanma
- Wiki içeriğini filtreleme veya yazdırma 1
Not
Yazdırma özelliği Firefox web tarayıcısından kullanılamayabilir.
Wiki içeriğini biçimlendirme
Mevcut Git depolarını wiki'de yayımlama
Birçok ekip Markdown kullanarak kodlarını belgeler ve kodla birlikte bu dosyaları iade edin. Git, standart çekme isteklerinin yanı sıra bu tür belgelerin bakımını ve gözden geçirilmesini desteklese de, bu tür dosyalar içeriğin tüketicilerine birkaç zorluk sunar.
- Okuyucular, ilgi çekici içeriği bulmak için genellikle birçok dosya ve klasör arasında geçiş yapmalıdır.
- İçerikte kuruluş ve yapı yok. Okuyucuları destekleyecek doğal bir sayfa hiyerarşisi yoktur.
- İçerik sürümü oluşturma desteklenmez.
- İçerikte arama, içerik aramak için en iyi duruma getirilmiş bir arama deneyimi yerine kodlarda arama yapmaktan geçer.
Kodu wiki olarak yayımlama özelliğiyle, ekip projenizde tanımlanan bir veya daha fazla Git deposunu wiki'de yayımlayabilirsiniz. Bu özellik, içeriğinizi kod tabanınızla birlikte korumanın bir yolunu sağlar ve içeriğinizi seçmeli olarak yayımlamanıza ve wiki'de güncelleştirmenize olanak tanır.
Ekip projesi için sağladığınız wiki içeriğini yönetme yönteminiz ile Git deposundan yayımladığınız wiki sayfaları arasında önemli farklar vardır. Ayrıntılar için bkz . Wiki'de Git deposu yayımlama.
Markdown
Markdown, metin biçimlendirmeyi ve resim eklemeyi kolaylaştırır. Ayrıca proje sayfalarınızdaki belgelere, BENİOKU dosyalarına, panolara ve çekme isteklerine de bağlanabilirsiniz. Markdown'ı kullanarak aşağıdaki yerlerde ekibinize rehberlik sağlayabilirsiniz:
Desteklenen söz dizimi için bkz . Azure DevOps'ta Markdown kullanma.
BENİOKU dosyaları
Her depo veya takım projesi için bir BENİOKU dosyası veya birden çok dosya tanımlayabilirsiniz. README'nizi düz metin yerine Markdown'a yazın.
Katkıda bulunanları projenizde çalışacak şekilde yönlendirmek için README sayfalarını kullanın. Aşağıdaki yönergeleri eklemeyi göz önünde bulundurun:
- Proje odağı
- Önkoşullar
- Ortamı ayarlama
- Proje içinde iş yapma ipuçları
- Belirli dosyaların amacı veya kullanımı
- Projeye özgü terimler ve kısaltmalar
- Değişiklikleri işleme veya karşıya yükleme ve dal ekleme hakkında iş akışı kılavuzu
- Proje sponsorları veya ilgili kişiler
Bu biçimi kullanan ve referans ve ilham almak için tüm hedef kitlelerle konuşan bazı harika README'ler aşağıdadır: