Karma Gerçeklik geliştirici belgelerine katkıda bulunma

Karma Gerçeklik geliştirici belgeleri için genel depoya hoş geldiniz! Bu depoda oluşturduğunuz veya düzenlediğiniz tüm makaleler genel kullanıma açık olacaktır.

Karma Gerçeklik belgeleri artık Markdig özellikleriyle GitHub özellikli Markdown kullanan Microsoft Learn'de barındırılıyor. Bu depoda düzenlediğiniz içerik, konumunda /windows/mixed-realitygörünen stilize sayfalara biçimlendirilir.

Bu sayfa, markdown temel bilgilerine katkıda bulunmaya yönelik temel adımları ve yönergeleri ve bağlantıları kapsar. Katkılarınız için teşekkür ederiz!

Kullanılabilir depolar

Depo adı	URL
Azure Object Anchors	MicrosoftDocs/azure-docs/articles/object-anchors
Azure Remote Rendering	MicrosoftDocs/azure-docs/articles/remote-rendering
Azure Spatial Anchors	MicrosoftDocs/azure-docs/articles/spatial-anchors
HoloLens	MicrosoftDocs/HoloLens
Karma Gerçeklik	MicrosoftDocs/karma gerçeklik
VR Meraklıları Kılavuzu	MicrosoftDocs/karma gerçeklik/enthusiast-guide

Başlamadan önce

Henüz bir hesabınız yoksa bir GitHub hesabı oluşturmanız gerekir.

Not

Microsoft çalışanıysanız GitHub hesabınızı Microsoft Açık Kaynak portalındaki Microsoft diğer adınıza bağlayın. "Microsoft" ve "MicrosoftDocs" kuruluşlarına katılın.

GitHub hesabınızı ayarlarken şu güvenlik önlemlerini de öneririz:

• Github hesabınız için güçlü bir parola oluşturun.
• İki öğeli kimlik doğrulamasını etkinleştirin.
• Kurtarma kodlarınızı güvenli bir yere kaydedin.
• Genel profil ayarlarınızı güncelleştirin.
  • Adınızı ayarlayın ve Genel e-postanızı E-postaadresimi gösterme olarak ayarlamayı göz önünde bulundurun.
  • Katkıda bulunan belge sayfalarında bir küçük resim gösterildiği için profil resmini karşıya yüklemenizi öneririz.
• Komut satırını kullanmayı planlıyorsanız , Windows için Git Kimlik Bilgileri Yöneticisi'ni ayarlamayı göz önünde bulundurun. Bu şekilde, her katkı yaptığınızda parolanızı girmeniz gerekmez.

Yayımlama sistemi GitHub'a bağlıdır, bu nedenle bu adımlar önemlidir. GitHub diğer adınızı kullanarak her makalenin yazarı veya katkıda bulunanı olarak listelenirsiniz.

Var olan bir makaleyi düzenleme

Web tarayıcısında GitHub aracılığıyla mevcut bir makalede güncelleştirmeler yapmak için aşağıdaki iş akışını kullanın:

1. "mixed-reality-docs" klasöründe düzenlemek istediğiniz makaleye gidin.

2. Sağ üstteki düzenle düğmesini (kalem simgesi) seçin; bu düğme otomatik olarak 'ana' daldan atılabilir bir dal çatalı oluşturur.

   

3. Makalenin içeriğini "Markdown temel bilgileri"ne göre düzenleyin.

4. Her makalenin üst kısmındaki meta verileri güncelleştirin:

   • title: Makale görüntülenirken tarayıcı sekmesinde görüntülenen sayfa başlığı. Sayfa başlıkları SEO ve dizin oluşturma için kullanılır, bu nedenle gerekli olmadıkça başlığı değiştirmeyin (belgeler genel kullanıma açık hale gelmeden önce bu daha az kritiktir).
   • açıklama: Seo ve bulmayı artıran makalenin içeriği hakkında kısa bir açıklama yazın.
   • author: Sayfanın birincil sahibiyseniz GitHub diğer adınızı buraya ekleyin.
   • ms.author: Sayfanın birincil sahibiyseniz Microsoft diğer adınızı buraya ekleyin (yalnızca diğer adı kullanmanız gerekmez @microsoft.com).
   • ms.date: Sayfaya büyük içerik ekliyorsanız, ancak netleştirme, biçimlendirme, dil bilgisi veya yazım denetimi gibi düzeltmeler için eklenmiyorsanız tarihi güncelleştirin.
   • anahtar sözcükler: Anahtar sözcükler SEO'ya yardımcı olur (arama motoru iyileştirmesi). Virgül ve boşlukla ayrılmış, makalenize özgü anahtar sözcükler ekleyin, ancak listenizdeki son anahtar sözcüklerden sonra noktalama işareti eklemeyin. Başka bir yerde yönetildiğinden, tüm makaleler için geçerli olan genel anahtar sözcükler eklemeniz gerekmez.

5. Makale düzenlemelerinizi tamamladığınızda aşağı kaydırın ve Dosya değişikliği öner'i seçin.

6. Otomatik olarak oluşturulan dalınızı 'ana' ile birleştirmek için sonraki sayfada Çekme isteği oluştur'u seçin.

7. Düzenlemek istediğiniz sonraki makale için yukarıdaki adımları yineleyin.

Var olan bir makaleyi yeniden adlandırma veya silme

Değişikliğiniz mevcut bir makaleyi yeniden adlandıracak veya silecekse, yeniden yönlendirme eklediğinizden emin olun. Bu şekilde, mevcut makalenin bağlantısına sahip olan herkes doğru yerde olmaya devam eder. Yeniden yönlendirmeler, deponun kökündeki .openpublishing.redirection.json dosyası tarafından yönetilir.

.openpublishing.redirection.json dosyasına yeniden yönlendirme eklemek için diziye redirections bir girdi ekleyin:

{
    "redirections": [
        {
            "source_path": "mixed-reality-docs/old-article.md",
            "redirect_url": "new-article#section-about-old-topic",
            "redirect_document_id": false
        },
    ...
    ]
}

• source_path, kaldırdığınız eski makalenin göreli depo yoludur. Yolun ile başladığından ve ile mixed-reality-docs.mdbittiğinden emin olun.
• redirect_url, eski makaleden yeni makaleye göreli genel URL'dir. Bu URL'nin depo yolunu değil genel URL'yi ifade eden veya .mdiçermediğinden mixed-reality-docs emin olun. kullanarak #section yeni makalenin içindeki bir bölüme bağlanmaya izin verilir. Gerekirse burada başka bir sitenin mutlak yolunu da kullanabilirsiniz.
• redirect_document_id önceki dosyadaki belge kimliğini korumak isteyip istemediğinizi gösterir. Varsayılan değer: false. Yeniden yönlendirilen makaledeki ms.documentid öznitelik değerini korumak istiyorsanız kullanıntrue. Belge kimliğini korursanız, sayfa görünümleri ve derecelendirmeler gibi veriler hedef makaleye aktarılır. Yeniden yönlendirme, yalnızca aynı içeriğin bir kısmını kapsayan farklı bir makalenin işaretçisi değil, öncelikli olarak yeniden adlandırma ise bunu yapın.

Yeniden yönlendirme eklerseniz, eski dosyayı da sildiğinizden emin olun.

Yeni makale oluşturma

Bir web tarayıcısında GitHub aracılığıyla belge deposunda yeni makaleler oluşturmak için aşağıdaki iş akışını kullanın:

1. MicrosoftDocs/mixed-reality 'master' dalından bir çatal oluşturun (sağ üstteki Çatal düğmesini kullanarak).

   

2. "mixed-reality-docs" klasöründe sağ üst kısımdaki Yeni dosya oluştur'u seçin.

3. Makale için bir sayfa adı oluşturun (boşluk yerine kısa çizgi kullanın ve noktalama işareti veya kesme işareti kullanmayın) ve ".md" ekleyin

   

   Önemli

   Yeni makaleyi "mixed-reality-docs" klasöründen oluşturduğunuzdan emin olun. Yeni dosya adı satırında "/mixed-reality-docs/" öğesini denetleyerek bunu doğrulayabilirsiniz.

4. Yeni sayfanızın en üstüne aşağıdaki meta veri bloğunu ekleyin:

   ---
   title:
   description:
   author:
   ms.author:
   ms.date:
   ms.topic: article
   keywords:
   ---
   

5. Yukarıdaki bölümde yer alan yönergelere göre ilgili meta veri alanlarını doldurun.

6. Markdown temel bilgilerini kullanarak makale içeriği yazın.

7. Makalenin en altına diğer ilgili makalelerin bağlantılarını içeren bir ## See also bölüm ekleyin.

8. İşiniz bittiğinde Yeni dosya işle'yi seçin.

9. Yeni çekme isteği'ni seçin ve çatalınızın 'ana' dalını MicrosoftDocs/mixed-reality 'master' ile birleştirin (okun doğru yolu işaretdiğinden emin olun).

   

Markdown temelleri

Aşağıdaki kaynaklar, Markdown dilini kullanarak belgeleri düzenlemeyi öğrenmenize yardımcı olur:

• Markdown temelleri
• Bir bakışta Markdown başvuru posteri
• Microsoft Learn için Markdown yazmaya yönelik ek kaynaklar

Tablo ekleme

Microsoft teknik belge tablolarının stilleri nedeniyle, satır içi CSS'yi deneseniz bile kenarlıkları veya özel stilleri olmaz. Kısa bir süre için çalışıyor gibi görünür, ancak sonunda platform stili tablodan çıkarır. Bu nedenle önceden plan yapın ve tablolarınızı basit tutun. Markdown tablolarını kolaylaştıran bir site aşağıdadır.

Visual Studio Code için Docs Markdown Uzantısı, belgeleri düzenlemek için Visual Studio Code (aşağıya bakın) kullanıyorsanız tablo oluşturmayı da kolaylaştırır.

Görüntü ekleme

Görüntülerinizi depodaki "mixed-reality-docs/images" klasörüne yüklemeniz ve ardından makalede uygun şekilde başvurmanız gerekir. Görüntüler otomatik olarak tam boyutta gösterilir ve bu da büyük resimlerin makalenin tüm genişliğini dolduracağı anlamına gelir. Karşıya yüklemeden önce görüntülerinizi önceden boyutlandırmanızı öneririz. Önerilen genişlik 600 ile 700 piksel arasındadır, ancak yoğun bir ekran görüntüsü veya ekran görüntüsünün bir bölümüyse, sırasıyla yukarı veya aşağı boyutlandırmanız gerekir.

Önemli

Birleştirmeden önce yalnızca çatallanmış deponuza görüntü yükleyebilirsiniz. Bu nedenle, bir makaleye resim eklemeyi planlıyorsanız, önce Visual Studio Code kullanarak resimleri çatalınızın "images" klasörüne eklemeniz veya bir web tarayıcısında aşağıdakileri yaptığınızdan emin olmanız gerekir:

1. MicrosoftDocs/karma gerçeklik deposu çatalını oluşturma.
2. Çatalınızdaki makaleyi düzenlediniz.
3. Makalenizde başvuruda bulunmakta olduğunuz görüntüleri çatalınızdaki "mixed-reality-docs/images" klasörüne yükledik.
4. Çatalınızı MicrosoftDocs/karma gerçeklik 'ana' dalı ile birleştirmek için bir çekme isteği oluşturuldu.

Kendi çatallı deponuzu ayarlamayı öğrenmek için yeni bir makale oluşturma yönergelerini izleyin.

Çalışmanızın önizlemesini görüntüleme

Web tarayıcısı aracılığıyla GitHub'da düzenleme yaparken, işlemeden önce çalışmanızın önizlemesini görüntülemek için sayfanın üst kısmındaki Önizleme sekmesini seçebilirsiniz.

Not

Hazırlanan değişikliklerinizin önizlemesini görüntülemek yalnızca Microsoft çalışanları tarafından kullanılabilir

Microsoft çalışanları: Katkılarınız 'ana' dalı ile birleştirildikten sonra içeriği /windows/mixed-reality?branch=main adresinde genel kullanıma açmadan önce gözden geçirebilirsiniz. Sol sütundaki içindekiler tablosunu kullanarak makalenizi bulun.

Tarayıcıda düzenleme ve masaüstü istemcisiyle düzenleme karşılaştırması

Tarayıcıda düzenleme, hızlı değişiklikler yapmanın en kolay yoludur, ancak bazı dezavantajları vardır:

• Yazım denetimi alamıyorsun.
• Diğer makalelere akıllı bağlantı almazsınız (makalenin dosya adını el ile yazmanız gerekir).
• Görüntüleri karşıya yüklemek ve bunlara başvurmak zor olabilir.

Bu sorunlarla uğraşmak istemiyorsanız, katkıda bulunurken birkaç yararlı uzantıylaVisual Studio Code gibi bir masaüstü istemcisi kullanın.

Visual Studio Code’u kullanma

Yukarıda listelenen nedenlerden dolayı, belgeleri web tarayıcısı yerine düzenlemek için masaüstü istemcisi kullanmayı tercih edebilirsiniz. Visual Studio Code kullanmanızı öneririz.

Kurulum

Visual Studio Code bu depoyla çalışacak şekilde yapılandırmak için şu adımları izleyin:

1. Web tarayıcısında:
   1. Bilgisayarınız için Git'i yükleyin.
   2. Visual Studio Code yükleyin.
   3. Henüz yapmadıysanız MicrosoftDocs/karma gerçeklik için çatal oluşturun.
   4. Çatalınızdaki Kopyala veya indir'i seçip URL'yi kopyalayın.
2. Visual Studio Code'de çatalınızın yerel bir kopyasını oluşturun:
   1. Görünümmenüsünden Komut Paleti'ni seçin.
   2. "Git: Kopyala" yazın.
   3. Kopyaladığınız URL'yi yapıştırın.
   4. Kopyanın bilgisayarınıza kaydedileceği yeri seçin.
   5. Açılır pencerede Depoyu aç'ı seçin.

Belgeleri düzenleme

Visual Studio Code ile belgelerde değişiklik yapmak için aşağıdaki iş akışını kullanın:

Not

Yukarıdan makale düzenleme ve oluşturma yönergelerinin yanı sıra Markdown'ı düzenlemenin temelleri de Visual Studio Code kullanılırken geçerlidir.

1. Kopyalanan çatalınızın resmi depoyla güncel olduğundan emin olun.

   1. Web tarayıcısında, MicrosoftDocs/karma gerçeklik 'ana' içindeki diğer katkıda bulunanlardan gelen son değişiklikleri çatalınıza eşitlemek için bir çekme isteği oluşturun (okun doğru yolu işaretdiğinden emin olun).

      

   2. Visual Studio Code'de, yeni güncelleştirilmiş çatalınızı yerel kopyayla eşitlemek için eşitleme düğmesini seçin.

      

2. Visual Studio Code kullanarak kopyalanmış deponuzda makaleler oluşturun veya düzenleyin.

   1. Bir veya daha fazla makale düzenleyin (gerekirse "images" klasörüne resim ekleyin).

   2. Değişiklikleri Gezgin'ekaydedin.

      

   3. Kaynak Denetimi'ndetüm değişiklikleri işleyin (istendiğinde işleme iletisi yazın).

      

   4. Değişikliklerinizi kaynakla (GitHub'da çatalınız) eşitlemek için eşitleme düğmesini seçin.

      

3. Bir web tarayıcısında, çatalınızdaki yeni değişiklikleri MicrosoftDocs/karma gerçeklik 'ana' ile eşitlemek için bir çekme isteği oluşturun (okun doğru yolu işaretdiğinden emin olun).

   

Yararlı uzantılar

Belgeleri düzenlerken aşağıdaki Visual Studio Code uzantıları kullanışlıdır:

• Visual Studio Code için Docs Markdown Uzantısı - Aşağıdakiler gibi belge yazma seçenekleri menüsünü açmak için Alt+M tuşlarını kullanın:
  • Karşıya yüklediğiniz görüntüleri arayın ve bunlara başvurun.
  • Listeler, tablolar ve gibi belgelere özgü çağrılar gibi >[!NOTE]biçimlendirmeler ekleyin.
  • İç bağlantıları ve yer işaretlerini (sayfa içindeki belirli bölümlere bağlantılar) arayın ve bunlara başvurun.
  • Biçimlendirme hataları vurgulanır (daha fazla bilgi edinmek için farenizi hatanın üzerine getirin).
• Kod Yazım Denetleyicisi - yanlış yazılmış sözcüklerin altı çizili olacak; yanlış yazılmış bir sözcüğe sağ tıklayarak sözcüğü değiştirin veya sözlüğe kaydedin.