Wat, READMEs ve Markaşağı hakkında

Azure DevOps Services | Azure DevOps Server 2020 | Azure DevOps Server 2019 | TFS 2018-TFS 2015

Takımınızı veya projenize katkıda bulunanları desteklemek için Marku kullanarak takım projenize zengin biçimlendirme, tablolar ve görüntüler ekleyin. Bir takım projesi wiki, bir panoya eklediğiniz içerik, takım projesi BENIOKU dosyası veya başka bir depo BENIOKU dosyası içinde markı biçimini kullanabilirsiniz.

Takımınızı veya projenize katkıda bulunanları desteklemek için Marku kullanarak takım projenize zengin biçimlendirme, tablolar ve görüntüler ekleyin. Bir panoya, takım projesi BENIOKU dosyanıza veya diğer depo BENIOKU dosyasına eklediğiniz içerik içindeki markı biçimini kullanabilirsiniz.

Wiki

Diğer ekip üyeleriyle bilgi paylaşmak için takım projesi wiki 'nizi kullanın. Sıfırdan wiki sağladığınızda, yeni bir git deposu markı dosyalarınızı, görüntülerinizi, ekleri ve sayfa dizisini depolar. Bu wiki, içeriğini ve yapısını işbirliğine dayalı olarak düzenlemenizi destekler.



Not

Yerleşik wiki, TFS 2018 ve üzeri sürümlerde kullanılabilir. Azure DevOps Server indirmek için, bkz. Visual Studio indirmeleri.

Aşağıdaki özellikler takım projesi wiki için desteklenir.

Wiki sağlama veya oluşturma

Wiki içeriğiyle çalışma

Not

Print özelliği Firefox Web tarayıcısından kullanılamayabilir.

Wiki içeriğini biçimlendirme

Aşağıdaki özellikler, belirtilen TFS sürümünde veya sonraki sürümlerde oluşturduğunuz takım projesi wiki için desteklenir. Daha fazla bilgi edinmek için bkz. Takım projeniz için wiki oluşturma ve wiki sayfaları ekleme ve düzenleme.

Mevcut Git depolarını bir wiki 'ye yayımlama

Birçok ekip, kendi kodlarını Marku kullanarak belgeleyin ve bu dosyaları kodla birlikte iade ediyor. Git, bu belgelerde standart çekme istekleriyle birlikte bakım ve gözden geçirmeyi desteklerken, bu tür dosyalar içerik tüketicilerine yönelik birkaç zorluk sunar.

  • Okuyucuların, ilgilendiğiniz içerikleri bulmak için genellikle birçok dosya ve klasör ile aynı olması gerekir.
  • İçerik kuruluş ve yapıya sahip değil. Okuyucuları desteklemek için herhangi bir devralınmış sayfa hiyerarşisi yoktur.
  • İçerik sürümü oluşturma desteklenmiyor.
  • İçerik arama, içerik aramak için en iyi duruma getirilmiş bir arama deneyimi yerine kodu aramaya bağlıdır.

Kodu wiki olarak Yayımla özelliği sayesinde, takım projenizde tanımlanan bir veya daha fazla git deposu bir wiki 'ye yayımlayabilirsiniz. Bu özellik, içeriğinizi kod tabanınız ile birlikte korumak için bir yol sağlar, ancak içeriğinizi seçmeli olarak yayımlayın ve bir wiki 'ye güncelleştirebilir.

Bir ekip projesi için sağladığınız wiki içeriğini bir git deposundan yayımladığınız wiki sayfalarına göre yönetme hakkında önemli farklılıklar vardır. Ayrıntılar için bkz. wiki 'de git deposu yayımlama.

Markdown

Markaşağı, metni biçimlendirmeyi ve görüntüleri eklemeyi kolaylaştırır. Ayrıca, proje sayfalarınızda, BENIOKU dosyalarınızda, panolarda ve çekme isteği açıklamalarınızda bulunan belgelere de bağlanabilirsiniz.

Markaşağı kullanarak aşağıdaki yerlerde ekibinize kılavuzluk sağlayabilirsiniz:

Desteklenen sözdizimi için bkz. Markaşağı dosyaları, pencere öğeleri, Wika ve çekme isteği açıklamaları Için sözdizimi Kılavuzu.

Benioku dosyaları

Her depo veya takım projesi için bir BENIOKU dosyası ya da birden çok dosya tanımlayabilirsiniz. BENIOKU dosyanızı düz metin yerine Markaşağı içine yazın.

Katkıda bulunanları projeniz içinde çalışmaya yönlendirmek için BENIOKU sayfalarını kullanın. Aşağıdaki kılavuzu eklemeyi göz önünde bulundurun:

  • Project odağı
  • Önkoşullar
  • Ortamı ayarlama
  • İpuçları içinde işleri yapmak için gerekenler
  • Belirli dosyaların amacı veya kullanımı
  • Project terimler ve kısaltmalar
  • Değişiklikleri işleme veya karşıya yükleme ve dal ekleme hakkında iş akışı kılavuzu
  • Project sponsorlar veya kişiler

Başvuru ve ilham için bu biçimi kullanan ve tüm kitlelerle konuşan harika READM'ler: