Aracılığıyla paylaş

GitHub Codespaces kullanarak katkıda bulunma

GitHub'da, herhangi bir yazılımı yerel olarak yüklemek veya yapılandırmak zorunda kalmadan PowerShell belgelerine katkıda bulunmak için kullanabileceğiniz Codespaces adlı bir özellik vardır. Bir kod alanı kullandığınızda, ekibin yazma ve düzenleme için kullandığı yazma araçlarının aynısını elde edersiniz.

Tarayıcınızda bir kod alanı kullanarak, katkılarınızı İnternet üzerinden barındırılan VS Code'da yapabilirsiniz. VS Code'u yerel olarak yüklediyseniz, orada da codespace'a bağlanabilirsiniz.

Kullanılabilir araçlar

PowerShell belgelerine katkıda bulunmak için bir kod alanı kullandığınızda, düzenleyicinizde şu araçlar zaten kullanılabilir:

  • markdown sözdiziminizi kontrol etmek için markdownlint.
  • yazım denetimi için cSpell.
  • Prose'nizi kontrol etmek için Vale.
  • Platforma özgü söz dizimi ekleme, katkınızın önizlemesini görüntüleme ve daha fazlası için Learn Yazma Paketi .
  • Markdown'ınızı gerektiği gibi sarmalayıp okumayı ve düzenlemeyi kolaylaştırmak için Reflow Markdown uzantısı.
  • Sütunları el ile hizalamak zorunda kalmadan tablolarınızı daha okunabilir hale getirmek için Tablo Biçimlendirici uzantısı.
  • Başlıklarınızın ve yazınızın harflerinin yazım şeklini değiştirmeye yönelik case değiştirici uzantısı.
  • Geçmiş dosya değişikliklerini gözden geçirmek için GitLens uzantısı.
  • PowerShell örnekleriyle etkileşimli yazım için kullanılacak PowerShell uzantısı.
  • Markdown'ınızdaki sorunlu karakterleri bulmak için Visual Studio Code'da Gremlins takip edicisi.

Maliyet

GitHub Codespaces, ayda 120 çekirdek saate kadar ücretsiz olarak kullanılabilir. Aylık kullanım yalnızca belgelerde değil tüm depolarınızda hesaplanır.

Fiyatlandırma hakkında daha fazla bilgi için bkz. GitHub Codespaces için faturalama hakkında.

Tavsiye

Kapsayıcıları ve Docker'ı rahatça kullanıyorsanız, PowerShell belge depoları için tanımlanan devcontainer'ı kullanarak aynı deneyimi elde edebilirsiniz. Devcontainers kullanımıyla ilişkili bir maliyet yoktur. Daha fazla bilgi için Geliştirme Kapsayıcıları kılavuzuna bakınız.

GitHub Codespace'inizi oluşturma

PowerShell belgelerine katkıda bulunmak üzere GitHub Codespace'ınızı oluşturmak için şu adımları izleyin:

  1. tarayıcınızda https://github.com/codespaces açın.
  2. Sayfanın sağ üst kısmındaki "Yeni kod alanı" düğmesini seçin.
  3. "Yeni bir kod alanı oluştur" sayfasında, "Depo seçin" düğmesini seçin ve katkıda bulunmak istediğiniz deponun adını yazın( gibi MicrosoftDocs/PowerShell-Docs).
  4. Diğer tüm ayarları varsayılan olarak bırakın.
  5. "Kod alanı oluştur" düğmesini seçin.

Bu adımları takip ettikten sonra GitHub bu depo için yeni bir kod alanı oluşturur ve sizin için ayarlar. Kod alanı hazır olduğunda sayfa yenilenir ve kod alanının web düzenleyicisi kullanıcı arabirimini gösterir. Kullanıcı arabirimi VS Code'a dayanır ve aynı şekilde çalışır.

GitHub Codespace'inizi açma

GitHub Codespace'inizi tarayıcıda açmak için şu adımları izleyin:

  1. tarayıcınızda https://github.com/codespaces açın.
  2. Sayfada Codespaces'leriniz listelenir. Katkıda bulunmak istediğiniz depo için oluşturulan kod alanı bulun ve seçin.

Kod alanınızı seçtikten sonra GitHub bunu aynı pencerede açar. Buradan katkıda bulunmaya hazırsınız.

Vs Code'da GitHub Codespace'inizi açmak için Visual Studio Code'da GitHub Codespaces'ı kullanma bölümünde yer alan adımları izleyin.

GitHub Codespace'inizde yazılım geliştirme

GitHub Codespace'ınızı tarayıcınızda veya VS Code'unuzda açtıktan sonra, belgelere katkıda bulunmak aynı işlemi izler.

Bu makalenin geri kalanında, katkınızı yazarken veya düzenlerken GitHub Codespace'inizde gerçekleştirebileceğiniz çeşitli görevler açıklanmaktadır.

gibi bir satır içi bağlantıyı gibi [some text](destination.md)bir başvuru bağlantısına [some text][01]dönüştürmek istediğinizde, düzenleyicide bağlantı hedefini seçin. Ardından aşağıdakilerden birini yapabilirsiniz:

  1. Bağlantı hedefine sağ tıklayın ve bağlam menüsünde "Yeniden düzenle..." öğesini seçin.
  2. Ctrl+Shift+Rtuşlarına basın.

İki eylemin herhangi biri yeniden düzenleme bağlam menüsünü açar. Bağlantıdaki (destination.md) öğesini [def] ile değiştirmek için bağlam menüsünde Bağlantı tanımı için Ayıkla'yı seçin. bir ad yazarak tanımı yeniden adlandırabilirsiniz.

PowerShell belgeleri için, [01] veya [31] gibi iki basamaklı sayısal referans bağlantı tanımları kullanırız. Yalnızca makalelerde ve kavramsal belgelerde başvuru bağlantısı tanımlarını kullanın. Cmdlet başvuru belgelerinde başvuru bağlantısı tanımlarını kullanmayın.

Düz yazı stil ihlallerini düzeltme

Kod alanınızdaki bir makaleyi gözden geçirdiğinizde Vale, makaleyi ilk açtığınızda ve her kaydettiğinizde otomatik olarak denetler. Vale bir stil ihlali tespit ederse, bu ihlalleri belgede renkli dalgalı çizgilerle vurgular.

Daha fazla bilgi görmek için bir ihlalin üzerine gelin.

Kuralı açıklayan bir web sayfası açmak için, vurgulama bilgilerinde kuralın adını seçin. Kuralı açmak ve uygulamasını gözden geçirmek için kuralın dosya adını (ile biten .yml) seçin.

Kural hızlı düzeltmeyi destekliyorsa, ihlal için uçan bilgi penceresinde "Hızlı Düzeltme..." seçeneğini belirleyebilirsiniz. Ardından, bağlam menüsünden önerilen düzeltmelerden birini seçip uygulayabilirsiniz. Ayrıca, Ctrl tuşuna+ da basabilirsiniz. İmleciniz vurgulanmış bir sorun üzerindeyken, kural destekliyorsa hızlı bir düzeltme uygulamak için.

Kural hızlı düzeltmeleri desteklemiyorsa kuralın iletisini okuyun ve yapabilirseniz düzeltin. Nasıl düzeltileceğini bilmiyorsanız, editörler çekme isteğinizi incelerken bir öneride bulunabilir.

Söz dizimi sorunlarını düzeltme

Kod alanınızdaki bir makaleyi gözden geçirdiğinizde Markdownlint, makaleyi açtığınızda ve yazarken otomatik olarak denetler. Markdownlint söz dizimi hataları bulursa, bunları belgede renkli dalgalı çizgilerle işaretler.

Daha fazla bilgi görmek için bir ihlalin üzerine gelin. Kuralı açıklayan bir web sayfası açmak için, üzerine gelindiğinde görünen bilgide kuralın ID'sini seçin.

Kural hızlı düzeltmeyi destekliyorsa, ihlal için uçan bilgi penceresinde "Hızlı Düzeltme..." seçeneğini belirleyebilirsiniz. Ardından, bağlam menüsünden önerilen düzeltmelerden birini seçip uygulayabilirsiniz. Ayrıca, Ctrl tuşuna+ da basabilirsiniz. İmleciniz vurgulanmış bir sorun üzerindeyken, kural destekliyorsa hızlı bir düzeltme uygulamak için.

Kural hızlı düzeltmeleri desteklemiyorsa kuralın iletisini okuyun ve yapabilirseniz düzeltin. Nasıl düzeltileceğini bilmiyorsanız, editörler çekme isteğinizi incelerken bir öneride bulunabilir.

Ayrıca, bir makaledeki tüm söz dizimi ihlallerine düzeltmeler uygulayabilirsiniz. Bunu yapmak için komut paletini açın ve yazın Fix all supported markdownlint violations in the document. Siz yazarken komut paleti kullanılabilir komutları filtreler. "Belgedeki tüm desteklenen markdownlint ihlallerini düzelt" komutunu seçin. Bunu yaptığınızda Markdownlint, hızlı bir düzeltmesi olan ihlalleri çözmek için belgeyi güncelleştirir.

Tabloyu biçimlendirme

Markdown tablosunu biçimlendirmek için imlecinizi Markdown tablonuzun içinde veya üzerinde yerleştirin. Komut Paleti'ni açın ve Table: Format Current komutunu arayın. Bu komutu seçtiğinizde, tablonuzun Markdown'ını daha iyi okunabilirlik için hizalar ve dolgu ekleyerek günceller.

Aşağıdaki gibi tanımlanan bir tabloyu dönüştürür:

| foo | bar | baz |
|:--:|:--|-:|
| a | b | c |

Bunun içine:

|  foo  | bar  | baz  |
| :---: | :--- | ---: |
|   a   | b    |    c |

Uyarı ekleme

Belgelerde, bilgileri okuyucular için daha önemli hale getirmek için uyarılar kullanılır.

Uyarı eklemek için Komut Paleti'ni açıp komutu arayabilirsiniz Learn: Alert . Bu komutu seçtiğinizde bir bağlam menüsü açılır. Eklemek istediğiniz uyarı türünü seçin. Bunu yaptığınızda, komut uyarının Markdown kodunu belgeye, imlecinizin olduğu yere ekler.

Başlığı cümle biçimlendirmesiyle yapın

Bir başlığın yazı biçimini değiştirmek için, başlık düzeyini ayarlayan baştaki # simgeler hariç başlığın metnini seçin. Metni vurguladığınızda Komut Paleti'ni açın ve komutu arayın Change case sentence . Bu komutu seçtiğinizde, vurgulanan metnin büyük/küçük harflerini dönüştürür.

Belgedeki herhangi bir metin için büyük/küçük harf komutlarını da kullanabilirsiniz.

Komut Paleti'ni açma

Birçok yararlı komut çalıştırmak için VS Code'un Komut Paleti'ni kullanabilirsiniz.

Kullanıcı arabiriminde Komut Paleti'ni açmak için üst menü çubuğundan "Görünüm"ü seçin. Ardından bağlam menüsünde "Komut Paleti..." öğesini seçin.

Komut Paleti'ni klavyenizle açmak için işletim sisteminizin tuş bileşimine basın:

  • Windows ve Linux: Ctrl+Shift+P
  • macOS: Cmd+Shift+P

Katkınızın önizlemesini görüntüleme

Katkınızın önizlemesini görüntülemek için Komut Paleti'ni açın ve komutu arayın Markdown: Open Preview . Bu komutu seçtiğinizde VS Code etkin belgenin önizlemesini açar. Önizlemenin stili Learn platformuyla eşleşir.

Uyarı

Siteye göreli ve çapraz referans bağlantıları önizlemede çalışmaz.

İçeriğinizi yeniden düzenleyin

Belgedeki paragrafın satır uzunluklarını sınırlamak için imlecinizi paragrafın üzerine getirin. Ardından Komut Paleti'ni açın ve komutunu arayın Reflow Markdown . Komutu seçtiğinizde, geçerli paragrafın satır uzunluklarını yapılandırılan uzunlukla güncelleştirir. Depolarımız için bu uzunluk 99 karakterdir.

Blok alıntılar için bu komutu kullanırken, yeniden düzenlediğiniz blok alıntısındaki paragrafın boş satırlarla çevrelendiğinden emin olun. Aksi takdirde, komut her paragrafı yeniden düzenler.

Dikkat

Makaleleri düzenlerken bu komutu kullanmayın. Bu belgelerdeki satırlar 80 karakterden uzun olmamalıdır. Şu anda bir deponun klasöre veya dosya adına göre farklı satır uzunluklarını yapılandırmasının bir yolu yoktur, bu nedenle makale belgeleri hakkında reflow çalışmaz.

Belgedeki tüm sorunları gözden geçirme

Belgedeki tüm söz dizimi ve stil kuralı ihlallerini gözden geçirmek için Sorunlar Görünümü'nü açın.

Kullanıcı arabiriminde Sorunlar Görünümü'nü açmak için üst menü çubuğundan "Görünüm"ü seçin. Ardından bağlam menüsünden "Sorunlar"ı seçin.

Sorun Görünümü'nü klavyenizle açmak için işletim sisteminizin tuş bileşimine basın:

  • Windows ve Linux: Ctrl+Shift+M
  • macOS: Cmd+Shift+M

Sorunlar Görünümü açık belgeyle ilgili tüm hataları, uyarıları ve önerileri görüntüler. Belgede kaydırmak için bir sorun seçin.

Sorunları türe veya metin eşleştirmeye göre filtreleyebilirsiniz.

ms.date meta verilerini güncelleştirme

Bir makalenin ms.date meta verilerini güncelleştirmek için Komut Paleti'ni açın ve komutunu arayın Learn: Update "ms.date" Metadata Value . Komutu seçtiğinizde meta verileri geçerli tarihe güncelleştirir.

Ek kaynaklar

Bu makalede açıklanan görevler ve komutlar, VS Code veya yüklü uzantılarla yapabileceğiniz her şeyi kapsamaz.

VS Code kullanma hakkında daha fazla bilgi için şu makalelere bakın:

Yüklü uzantılar hakkında daha fazla bilgi için belgelerine bakın:

  • Last updated on