PowerShell belgelerine katkıda bulunmaya başlayın


Bu makale, PowerShell belgelerine katkıda bulunan biri olarak nasıl başlayacağınıza dair bir genel bakıştır.

PowerShell-Docs yapısı

PowerShell-Docs deposu iki içerik grubuna ayrılmıştır: referans ve kavramsal.

Referans içeriği

Referans içeriği, PowerShell'de gönderilen cmdlet'ler için PowerShell cmdlet referansıdır. Cmdlet referansı, PowerShell ile birlikte gelen modüllere referans içeren sürümlendirilmiş klasörlerde (5.1, 7.0 ve 7.2 gibi) toplanır. Bu içerik aynı zamanda Get-Help cmdlet'i tarafından görüntülenen yardım bilgilerini oluşturmak için de kullanılır.

Kavramsal içerik

Kavramsal belgeler sürüme göre düzenlenmemiştir. Tüm makaleler PowerShell'in her sürümü için görüntülenir.

Not

Kavramsal bir makale eklendiğinde, kaldırıldığında veya yeniden adlandırıldığında, TOC güncellenmeli ve silinmeli veya yeniden adlandırılan dosyalar yeniden yönlendirilmelidir.

Yeni makaleler oluşturma

Katkıda bulunmak istediğiniz her yeni belge için bir GitHub sayısı oluşturulmalıdır. Çabaları tekrarlamadığınızdan emin olmak için mevcut sorunları kontrol edin. Atanan sorunların devam ettiği olduğu kabul edilir. Bir sorun üzerinde işbirliği yapmak isterseniz, konuya atanan kişiyle iletişime geçin.

PowerShell RFC işlemine benzer şekilde içeriği yazmadan önce bir sorun oluşturun. Bu sorun, PowerShell-Docs ekibi tarafından reddedilen işlerde zaman ve çaba harcamamanızı sağlar. Bu sorun, içeriğin kapsamı ve PowerShell belgelerinin neresinde yer aldığı konusunda size danışmamıza olanak tanır. Tüm makaleler İçindekiler Tablosuna (TOC) dahil edilmelidir. Önerilen TOC konumu konu tartışmasına dahil edilmelidir.

Not

Referans içeriğine ilişkin TOC, yayınlama sistemi tarafından otomatik olarak oluşturulur. TOC'yi güncellemeniz gerekmez.

Mevcut makalelerin güncellenmesi

Uygun olduğu durumlarda, cmdlet referans makaleleri bu depoda tutulan tüm PowerShell sürümlerinde kopyalanır. Bir cmdlet referansı veya Hakkında_ makalesi hakkında bir sorun bildirirken, sorunun yaşandığı makalenin sürümlerini listeleyin.

Dosyanın her sürümüne uygun değişikliği uygulayın.

Yerelleştirilmiş içerik

PowerShell belgeleri İngilizce yazılmış ve diğer 17 dile çevrilmiştir. İngilizce içerik MicrosoftDocs/PowerShell-Docs adlı GitHub deposunda depolanır. Çevrilen içerikte bulunan sorunlar İngilizce arşive gönderilmelidir.

Tüm çeviriler öncelikle İngilizce içerikten başlar. Hem insan hem de makine çevirisini kullanıyoruz.

Human translation

de-DE, es-ES, fr-FR, it-IT, ja-JP, ko-KR, pt-BR, ru-RU, zh-CN, zh-TW

Machine translation

cs-CZ, hu-HU, nl-NL, pl-PL, pt-PT, sv-SE, tr-TR

Makine çevirisiyle çevrilen içerikler her zaman doğru kelime seçimleri ve dilbilgisi ile sonuçlanmayabilir. Makalenin teknik detayları yerine herhangi bir dilin çevirisinde hata bulursanız çevirinin neden hatalı olduğunu düşündüğünüzü açıklayan bir konu açın.

Bazı çeviri sorunları İngilizce kaynak dosyaları değiştirilerek çözülebilir. Ancak bazı sorunlar dahili çeviri sistemimizde güncellemeler gerektirebilir. Bu gibi durumlarda, incelenip yanıt verilmesi için sorunu dahili yerelleştirme ekibimize göndermemiz gerekir.

Sonraki adımlar

GitHub'da değişiklikleri göndermenin iki yaygın yolu vardır. Her iki yöntem de merkezi Katılımcı Kılavuzu'nda açıklanmıştır:

  1. GitHub web arayüzünde mevcut belgelerde hızlı düzenlemeler yapabilirsiniz.
  2. Yeni makaleler eklemek, birden fazla dosyayı güncellemek veya diğer büyük değişiklikler için GitHub iş akışının tamamını kullanın.

Herhangi bir değişikliğe başlamadan önce PowerShell-Docs deposunun bir çatalını oluşturmalısınız. Değişiklikler PowerShell-Docs kopyanızdaki çalışan bir dalda yapılmalıdır. GitHub'da hızlı düzenleme yöntemini kullanıyorsanız bu adımlar sizin için gerçekleştirilir. GitHub iş akışının tamamını kullanıyorsanız yerel olarak çalışacak şekilde ayarlanmış olmanız gerekir.

Her iki yöntem de bir Çekme İsteğinin (PR) oluşturulmasıyla sona erer. Daha fazla bilgi ve en iyi uygulamalar için bkz. Çekme isteği gönderme.

İlgili makaleler