İngilizce dilinde oku

Aracılığıyla paylaş


HoloLens belgelerine katkıda bulunma

HoloLens belgelerinehoş geldiniz! Bu depoda oluşturduğunuz veya düzenlediğiniz tüm makaleler genel kullanıma görünür.

HoloLens belgeleri, GitHub özellikli Markdown ve Markdig özelliklerini kullanan Microsoft Learn'de yayımlanır. Bu depoda düzenlediğiniz içerik, /hololens'de gö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ınız için teşekkür ederiz!

Kullanılabilir depolar

Depo adı URL
HoloLens MicrosoftDocs/HoloLens
Karma Gerçeklik MicrosoftDocs/karma gerçeklik
VR Meraklıları Kılavuzu MicrosoftDocs/mixed-reality/enthusiast-guide

Başlamadan önce

Henüz yoksabir GitHub hesabı oluşturmanız gerekir.

Not

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

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

  • GitHub hesabınız için güçlü bir parola oluşturun.
  • iki öğ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-postaE-posta adresimi göstermeolarak ayarlayın.
    • Katkıda bulunan Microsoft Learn makalelerinde küçük resim gösterildiği için profil resmini karşıya yüklemenizi öneririz.
  • Komut satırını kullanmayı planlıyorsanız, Windowsiçin Git Kimlik Bilgileri Yöneticisi'ni ayarlamayı düşünün. 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 makale güncelleştirmeler yapmak için aşağıdaki iş akışını kullanın:

  1. "hololens" klasöründe düzenlemek istediğiniz makaleye gidin.

  2. Sağ üstteki düzenle düğmesini (kalem simgesi) seçin.

    Makale düzenleme.

    Bu, varsayılan daldan atılabilir bir dalı otomatik olarak çatallar ana.

  3. Makalenin içeriğini Markdown temel bilgilerigöre düzenleyin.

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

    • başlık: 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 çıkmadan önce bu daha az kritik olsa da).
    • açıklama: Seo ve bulmayı artıran makalenin içeriğinin kısa bir açıklamasını yazın.
    • yazar: 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 (gerekmez, yalnızca diğer ad).
    • ms.date: Sayfaya ana içerik ekliyorsanız tarihi güncelleştirin, ancak açıklama, biçimlendirme, dil bilgisi veya yazım denetimi gibi düzeltmeler için güncelleştirin.
    • anahtar sözcükler: Anahtar sözcükler SEO'ya (arama motoru iyileştirme) yardımcı olabilir. Virgül ve boşlukla ayrılmış, makalenize özgü ancak listenizdeki son anahtar sözcüklerden sonra noktalama işareti olmayan anahtar sözcükler ekleyin. Bunlar 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 önerseçin.

  6. Sonraki sayfada, otomatik olarak oluşturulan dalınızı varsayılan dalla birleştirmek için çekme isteği oluştur seçin ana.

  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 var olan bir makaleyi yeniden adlandıracak veya silecekse, yeniden yönlendirme eklemeyi unutmayın. Bu şekilde, mevcut makaleye bağlantısı 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'a yeniden yönlendirme eklemek için redirections dizisine bir girdi ekleyin:

{
    "redirections": [
        {
            "source_path": "hololens/old-article",
            "redirect_url": "/base-url/new-article#section-about-old-topic",
            "redirect_document_id": false
        },
  • source_path, kaldırdığınız eski makalenin göreli depo yoludur. Yolun docset ile başladığından (bu örnekte hololens) ve .md dosya uzantısını içerdiğinden emin olun.

  • redirect_url, eski makaleden yeni makaleye göreli genel URL'dir. Bu URL .md içermediğinden ve depo yoluna değil genel URL'ye başvurduğundan /ile başladığından emin olun. #section kullanarak yeni makaledeki bir bölüme bağlanmaya izin verilir. Gerekirse, burada başka bir sitenin mutlak yolunu da kullanabilirsiniz.

  • redirect_document_id, belge kimliğini önceki dosyadan saklamak isteyip istemediğinizi gösterir. Varsayılan değer false. Yeniden yönlendirilen makaledeki ms.documentid öznitelik değerini korumak istiyorsanız true kullanın. Belge kimliğini korursanız, sayfa görünümleri ve derecelendirmeler gibi veriler hedef makaleye aktarılır. Yeniden yönlendirme, aynı içeriğin yalnızca bir bölümünü kapsayan farklı bir makalenin işaretçisi değil, birincil 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. Sağ üstteki Çatal düğmesini kullanarak MicrosoftDocs/hololens anavarsayılan daldan bir çatal oluşturun.

    Fork'a şu anda "main" adlı varsayılan dalı .

  2. "hololens" klasöründe sağ üstteki Yeni dosya oluştur seçin.

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

    yeni sayfanızı adlandır'a .

    Önemli

    Yeni makaleyi "hololens" klasörünün içinden oluşturduğunuzdan emin olun. Yeni dosya adı satırında "/hololens/" öğesini denetleyerek bunu onaylayabilirsiniz.

  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. var olan bir makaleyi düzenleme daha önce açıklandığı gibi ilgili meta veri alanlarını doldurun.

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

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

  8. İşiniz bittiğinde yeni dosyaişle'yi seçin.

  9. yeni çekme isteği seçin ve çatalınızın ana dalını MicrosoftDocs/hololens ana birleştirin (okun doğru hedefe işaret olduğundan emin olun).

    Çatalınızdan MicrosoftDocs/hololens'e çekme isteği oluşturun.

Markdown temel bilgileri

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

  • Markdown temel
  • [ için Markdown yazmak için ek kaynaklar

Tablo ekleme

Microsoft Learn'de tabloların stili 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: [Tables Generator]](https://www.tablesgenerator.com/markdown_tables).

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.

Resim ekleme

Görüntülerinizi depodaki "hololens/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ında olsa da, sırasıyla yoğun bir ekran görüntüsü veya ekran görüntüsü kesirli olması durumunda boyutu artırmanız veya azaltmanız gerekir.

Önemli

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

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

Kendi çatallı deponuzu ayarlamayı öğrenmek içinyeni 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

Microsoft Learn'de yaptığınız değişikliklerin önizlemesini görüntülemek yalnızca Microsoft çalışanları tarafından kullanılabilir.

Microsoft çalışanları: Katkılarınız anavarsayılan dala birleştirildiğinde, /hololens?branch=mainadresinde genel kullanıma açık olmadan önce içeriği 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 yapamazsınız.
  • Diğer makalelere akıllı bağlantı sağlamazsı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 ilgilenmek istemiyorsanız, katkıda bulunurken birkaç yararlı uzantıyla Visual Studio Code gibi bir masaüstü istemcisi kullanın.

Visual Studio Code kullanma

üzerinde listelenen nedenlerden dolayı, belgeleri düzenlemek için web tarayıcısı yerine masaüstü istemcisi kullanmayı tercih edebilirsiniz. visual studio codekullanmanızı öneririz.

Kurulum

Visual Studio Code'u 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 codeyükleyin.
    3. Henüz yapmadıysanız MicrosoftDocs/hololens .
    4. Çatalınızdaki Kopyala'yı seçin veya indirip URL'yi kopyalayın.
  2. Visual Studio Code'da çatalınızın yerel bir kopyasını oluşturun:
    1. Görünüm menüsünden Komut Paletiöğesini seçin.
    2. "Git: Clone" 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.

Belgeler düzenleniyor

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

Not

düzenleme ve makaleleri oluşturmaya yönelik tüm yönergeler ve yukarıdan Markdowndüzenlemenin temelleri Visual Studio Code kullanılırken de geçerlidir.

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

    1. Web tarayıcısında, MicrosoftDocs/hololens'in varsayılan dalı olan anadiğ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 hedefe işaretdiğinden emin olun).

      MicrosoftDocs/hololens değişikliklerini çatalınıza eşitleyin.

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

      Eşitleme düğmesi resmine tıklayın.

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

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

    2. Gezgini'nde değişiklikleri kaydet.

      Gezgin "Tümünü kaydet"i seçin

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

      Kaynak Denetimi "Tümünü işle" seçeneğini belirleyin

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

      Eşitle düğmesine tıklayın.

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

    Çatalınızdan MicrosoftDocs/hololens'e çekme isteği oluşturun.

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ını - Alt+M kullanarak Aşağıdakiler gibi Microsoft Learn yazma seçeneklerinin bir menüsünü açın:

    • Karşıya yüklediğiniz görüntüleri arayın ve bunlara başvurun.
    • listeler, tablolar ve >[!NOTE]gibi çağrılar gibi biçimlendirmeler ekleyin.
    • İç bağlantıları ve yer işaretlerini (sayfadaki 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 değiştirin veya sözlüğe kaydedin.