PowerShell belgelerine katkıda bulunmaya başlama

Bu makale, PowerShell belgelerine katkıda bulunmaya nasıl başlayacağınıza dair genel bir bakış sunar.

PowerShell-Docs yapısı

PowerShell-Docs deposunda üç içerik kategorisi vardır:

• başvuru içeriği
• kavramsal içerik
• meta veriler ve yapılandırma dosyaları

Referans içeriği

Başvuru içeriği, PowerShell'de gönderilen cmdlet'ler için PowerShell cmdlet başvurusudur. Cmdlet referansı, PowerShell ile birlikte gelen modüllerin referanslarını içeren sürümlü klasörlerde (5.1, 7.4, 7.5 ve 7.6 gibi) toplanır. Bu içerik, 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, İçindekiler tablosu güncelleştirilmelidir. Silinen veya yeniden adlandırılan dosyalar yeniden yönlendirilmelidir.

Meta veri dosyaları

Bu proje çeşitli meta veri dosyası türleri içerir. Meta veri dosyaları, derleme araçlarımızın ve yayımlama sisteminin davranışını denetler. Yalnızca PowerShell-Docs bakımcıların ve onaylanan katkıda bulunanların bu dosyaları değiştirmesine izin verilir. Meta dosyanın değiştirilmesi gerektiğini düşünüyorsanız, gerekli değişiklikleri tartışmak için bir sorun açın.

Deponun kökündeki meta dosyalar

• .* - deponun kökündeki yapılandırma dosyaları
• *.md - Deponun kökündeki proje belgeleri
• *.yml - Deponun kökündeki proje belgeleri
• .devcontainer/* - devcontainer yapılandırma dosyaları
• .github/**/* - GitHub şablonları, eylemleri ve diğer meta dosyaları
• .vscode/**/* - VS Code uzantısı yapılandırmaları
• assets/* - belgelerde bağlantılı indirilebilir dosyaları içerir
• redir/* - yeniden yönlendirme eşleme dosyalarını içerir
• tests/* - derleme sistemi tarafından kullanılan test araçları
• tools/* - derleme sistemi tarafından kullanılan diğer araçlar

Belge kümesindeki meta dosyalar

• reference/**/*.json - docset yapılandırma dosyaları
• reference/**/*.yml - İçindekiler tablosu ve diğer yapılandırılmış içerik dosyaları
• reference/bread/* - içerik haritası gezinti yapılandırması
• reference/includes/* - markdown ekleme dosyaları
• reference/mapping/* - sürüm eşleme yapılandırması
• reference/**/media/** - Belgelerde kullanılan görüntü dosyaları
• reference/module/* - Modül Tarayıcısı sayfa yapılandırması

Yeni makaleler oluşturma

Katkıda bulunmak istediğiniz tüm yeni belgeler için bir GitHub sorunu oluşturulmalıdır. Çabaları yinelemediğinizden emin olmak için mevcut sorunları denetleyin. Atanan sorunlar in progress olarak kabul edilir. Bir sorun üzerinde işbirliği yapmak istiyorsanız, soruna 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 belgelerine nereye sığdığı konusunda size danışmamıza olanak tanır. Tüm makaleler İçindekiler Tablosu'na dahil edilmelidir. Önerilen içindekiler tablosu konumu, konu tartışmasına dahil edilmelidir.

Not

Yayımlama sistemi, başvuru içeriği için İçindekiler'i otomatik olarak oluşturur. İçindekiler Tablosu'nu güncelleştirmeniz gerekmez.

Mevcut makaleleri güncelleştirme

Uygun olduğunda, cmdlet başvuru makaleleri bu depoda tutulan tüm PowerShell sürümlerinde yinelenir. Cmdlet başvurusu veya About_ makalesiyle ilgili bir sorun bildirirken, sorunun mevcut olduğu makale 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 17 dile daha çevrilmiştir. İngilizce içerik, MicrosoftDocs/PowerShell-Docsadlı GitHub deposunda depolanır. Çevrilen içerikte bulunan sorunlar bu depoya gönderilmelidir.

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

Çeviri yöntemi	Diller
İnsan çevirisi	de-DE, es-ES, fr-FR, it-IT, ja-JP, ko-KR, pt-BR, ru-RU, zh-CN, zh-TW
Otomatik tercüme	cs-CZ, hu-HU, nl-NL, pl-PL, pt-PT, sv-SE, tr-TR

Makine çevirisi tarafından çevrilen içerik her zaman doğru sözcük seçimleri ve dil bilgisi ile sonuçlanmayabilir. Makalenin teknik ayrıntıları yerine herhangi bir dil için çeviride hata bulursanız, çevirinin neden yanlış olduğunu düşündüğünüze ilişkin bir sorun açın.

İngilizce kaynak dosyaları değiştirilerek bazı çeviri sorunları düzeltilebilir. Ancak bazı sorunlar, iç çeviri sistemimizde güncelleştirmeler gerektirebilir. Bu gibi durumlarda, sorunu gözden geçirme ve yanıt için iç 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 Katkıda Bulunan Kılavuzu'nda açıklanmıştır:

1. GitHub web arabiriminde mevcut belgelerde hızlı düzenlemeler yapabilirsiniz.
2. Yeni makaleler eklemek, birden çok dosyayı güncelleştirmek veya diğer büyük değişiklikler için tam GitHub iş akışı kullanın.

Değişikliklere başlamadan önce PowerShell-Docs deposunun bir kopyasını oluşturmanız gerekir. Değişiklikler PowerShell-Docs kopyanızdaki bir çalışma dalında yapılmalıdır. GitHub'da hızlı düzenleme yöntemini kullanıyorsanız, bu adımlar sizin için işlenir. tam GitHub iş akışını kullanıyorsanızyerel olarak çalışacak ayarlamanız gerekir.

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