PowerShell Belgeleri Deneyimimizdeki Güncelleştirmeler

Bu gönderi, Azure Growth and Ecosystem ekibi Genel Müdürü Jeff Sandquist tarafından yazılmıştır.

Bugün, docs.microsoft.com için yenilenmiş Azure PowerShell deneyimini kullanıcılarımıza sunduk. Bu deneyimde yapılan geliştirmeler arasında modül sürümü oluşturma, kod söz dizimi vurgulama, belgeleri düzenlemeye ve geliştirmeye yönelik özellikler, daha kolay gezinmeye olanak veren içindekiler listesi ve daha fazlası mevcut. Müşterilerden aldığımız geri bildirimler sayesinde PowerShell içeriğinin geliştirmemiz gereken bir alan olduğunun farkındayız. Bu, içeriğimizin kalitesini geliştirme yolculuğumuzun bir sonraki adımı olacak. Bu yolculuğa Azure ile başladık, ancak önümüzdeki aylarda PowerShell içeriğimizin tamamını da bu deneyime taşıyacağız.

Birleştirilmiş PowerShell Modülü Başvurusu

PowerShell Modülü başvuru belgelerimizin amacı, Microsoft’un sunduğu tüm PowerShell modülleri için birleştirilmiş bir deneyim sağlamaktır. Buna aşağıdakiler dahildir:

  • Tutarlı URL Desenleri - Modülün veya bir cmdlet’in adını biliyorsanız URL’yi de biliyorsunuz demektir. Docs’ta kullandığımız URL deseni şudur: docs.microsoft.com/powershell/module/{module-name}/{cmdlet-name}/. AzureRM.Storage modülündeki Get-AzureRMStorageAccount cmdlet’inin URL’si şudur: https://docs.microsoft.com/powershell/module/azurerm.storage/get-azurermstorageaccount
  • Tutarlı kullanıcı deneyimi - Modülleri, cmdlet’leri ve örnekleri biçimlendirme işlemini artık tüm PowerShell belge deneyimlerinde aynı şekilde gerçekleştirebilirsiniz.
  • Kolayca katkı sağlama - PowerShell kullanıcıları, doğrudan belge sayfasında bulunan Düzenle düğmesine tıklayarak kod örnekleri ekleyebilir veya başvuru belgelerimizi düzenleyebilir.
  • PowerShell’in önceki sürümleri için sürüm oluşturma desteği - Azure PowerShell’in belirli bir sürümünü filtrelemek için sayfamızda bulunan sürüm seçiciyi kullanabilirsiniz.

PowerShell Sürüm Oluşturma

Belirli bir modül için sürüm oluşturmadan bahsettik ancak bazı modüller, her biri kendi sürüm oluşturma şemasına sahip başka modüllerle grup halinde sunulur. Örneğin, müşteriler PowerShellGet cmdlet’ini Azure PowerShell aracılığıyla indirir. Geçmişte müşteriler, yüklemeleri için hangi belge sürümlerinin geçerli olduğunu kendi kendilerine çözmek zorundaydı. Örneğin, Azure PowerShell 3.7 yüklediğinizde AzureRM 3.7’nin AzureRM.Automation 2.7 ve AzureRM.CognitiveServices v0.5.0 ile birlikte sunduğu her modülü bilmeniz ve bu belgeleri aramanız gerekirdi.

Yeni deneyimimizde seçmeniz gereken yalnızca tek bir sürüm vardır ve yüklemenize dayanarak uygun modüller filtrelenir.

PowerShell version selection

Geliştirilmiş içindekiler listesi

Cmdlet başvurusunun yanı sıra genel bakış içeriği, yükleme adımları, başlangıç ve örnekler ekledik. Azure başvurusu için Azure Service’i temel alan cmdlet'leri de gruplandırdık.

Table of contents showing overview, samples, reference

İçindekiler listesinde yazarken filtreleme kolaylığı

Cmdlet veya hizmetleri aramak için harfleri girdiğiniz esnada solda bulunan içindekiler listesini kolayca filtreleyebilirsiniz.

Results filter as you type

Cmdlet sayfası geliştirmeleri

Geliştirilmiş renklendirme ve biçimlendirme

PowerShell cmdlet’leri artık renkli ve daha rahat okunabilecek biçimde.

Colorized PowerShell syntax

Parametre geliştirmeleri

Parametreleri gerekli veya isteğe bağlı olma durumuna göre grupladığımızda parametre listesi sırasız görünüyordu. Bunun yerine bölüm başlıkları ekleyerek gerekli parametreler ile isteğe bağlı parametreleri grupladık ve parametre adlarının renklendirme/stilini geliştirdik.

Grouping required and optional parameters

Daha Akıllı Kopyala/Yapıştır davranışı

Bazı PowerShell cmdlet kod örneklerimizin önünde PS C:\> eki bulunur. Artık kod örneği için Kopyala düğmesine bastığınızda aşağıdaki Not Defteri ekran görüntüsünde olduğu gibi PS C:\> ön ekini çıkaracağız.

Copy button removing text

Geri Bildiriminiz

Bu sürümde önemli gelişmeler gördüğünüzü umuyoruz. Geliştirmelerimize devam edeceğiz, bu nedenle lütfen bize Docs UserVoice yoluyla geri bildirimlerinizi gönderin.