Microsoft Learn belgeleri için Git ve GitHub temel bileşenleri

  • Makale

Genel bakış

Microsoft Learn belgelerine katkıda bulunan olarak, birden çok araç ve işlemle etkileşim kuracaksınız. Aynı projede diğer katkıda bulunanlarla paralel olarak, muhtemelen tam olarak aynı içerik üzerinde ve hatta aynı zamanda çalışırsınız. Tüm bunlar, Git ve GitHub yazılımları ile sağlanır.

Git, açık kaynaklı bir sürüm denetim sistemidir. Depolarda bulunan dosyaların dağıtılmış sürüm denetimi yoluyla bu tip toplu proje işbirliğini kolaylaştırır. Temel olarak Git, herhangi bir depoda birden çok katkıda bulunan tarafından yapılan iş akışlarını tümleştirmeyi mümkün kılar.

GitHub, Microsoft Learn içeriğini depolamak için kullanılanlar gibi Git depoları için web tabanlı bir barındırma hizmetidir. Herhangi bir proje için GitHub, ana depoyu barındırır ve katkıda bulunanlar, bu depodan kendi işlerinin kopyasını alabilirler.

Bu makalede, Microsoft Learn iş akışının parçası olan önemli terimler tanımlanmaktadır. Ayrıca Git ve GitHub depolarına genel bir bakış sağlar ve microsoft teknik belgeleri için içeriğin nasıl düzenlenip düzenlendiğinden de sorumlu olur.

Şube

Dallar, iş akışlarını (genellikle sürümler olarak adlandırılır) birbirinden ayırır. Katkılar her zaman belirli bir dal kapsamında yapılır.

İlgili değişiklikleri belirli bir dalda yalıtmak, bu değişiklikleri bağımsız olarak denetlemenize ve tanıtmanıza olanak tanır. Yaptığınız iş türüne bağlı olarak, deponuzda birkaç çalışma dalını kolayca oluşturabilirsiniz. Her biri farklı bir projeyi temsil eden birden çok dalda aynı anda çalışmak yaygın görülen bir durumdur.

Tüm depolar varsayılan dal (genellikle "ana" olarak adlandırılır) ve henüz varsayılan dal ile tümleştirilmemiş bir veya daha fazla devam eden dal (çalışma dalları olarak adlandırılır) içerir. Varsayılan dal, proje için geçerli sürüm ve "tek gerçeklik kaynağı" görevi görür. Depodaki diğer tüm dallar bu üst öğeden oluşturulur.

Mantıksal olarak ilişkili yeni bir değişiklik kümesi eklediğinizde, değişikliklerinizi yönetmek için bir çalışma dalı oluşturmak en iyi yöntemdir. Varsayılan dalda doğrudan değişiklik yapmanızı önermiyoruz.

Çatal

Bu terim normalde ana GitHub deposunun bir kopyasına başvururken isim olarak kullanılır. Pratikte, bir çatal aslında sadece başka bir depoyu ifade eder. Ancak özelliği, GitHub’ın bu çatal ile ana/üst depo arasında bir bağlantı bulundurmasıdır. Bu terim bazen "Önce depoyu çatallamalısınız" gibi bir fiil olarak kullanılır.

Git

Merkezi sürüm denetim sistemlerini (Team Foundation Server, SharePoint veya Visual Source gibi Kasa) biliyorsanız Git'in dağıtılmış modelini desteklemek için benzersiz bir katkı iş akışına ve terminolojisine sahip olduğunu fark edersiniz. Örneğin, normalde kullanıma alma/iade etme işlemleriyle ilişkili dosya kilitleme yoktur. Bunun yerine Git, dosyaları bayt bayt karşılaştırarak daha da ince bir düzeydeki değişikliklerle ilgilenir.

Git ayrıca, bir projenin içeriğini yönetmek için katmanlı bir yapı kullanır:

  • Depo - Aynı zamanda repo olarak bilinir, en üst düzey depolama birimidir. Bir depo bir veya daha fazla dal içerir.
  • Dal: Bir projenin içerik kümesini oluşturan dosya ve klasörleri içeren depolama birimi. Dallar hakkında daha fazla bilgi için bu makalenin Dal bölümüne bakın.

Katkıda bulunanlar, yerel ve GitHub seviyelerinde depoları güncelleştirmek ve yönlendirmek için Git’i kullanır:

  • Yerel depoları yönetmek ve GitHub depoları ile iletişime geçmek için Git komutlarını destekleyen Git Bash konsolu gibi araçlarla yerel olarak.
  • Ana depoya geri akan katkıların birleşimini yönetmek için Git’i tümleştiren www.github.com aracılığıyla.

GitHub

Not

Belge kılavuzu GitHub'ı kullanmayı temel alsa da, bazı ekipler Git depolarını barındırmak için Visual Studio Team Services kullanır. Visual Studio Takım Gezgini istemcisi, Visual Studio Team Services depoları ile etkileşime geçmek için bir GUI sağlar. Bu, bir komut satırından Git komutları kullanmaya alternatiftir.
Ayrıca, aşağıdaki yönergelerin çoğu GitHub'da Azure hizmet içeriğini barındırma deneyiminden en iyi yöntemler olarak geliştirilmiştir. Bunlar bazı Microsoft Learn depolarında gerekli olabilir.

Tüm iş akışları, herhangi bir belge projesinin ana deposunun depolandığı GitHub düzeyinde başlar ve biter. Katkıda bulunanların kendi kullanımları için oluşturduğu kopyalar birden fazla bilgisayara dağıtılır. Bu kopyalar sonunda projenin ana GitHub deposuyla uzlaştırılır.

Dizin düzeni

Projenin varsayılan dalı, projenin geçerli içerik sürümü olarak görev görür. Varsayılan daldaki ve bu dallardan oluşturulan dallardaki içerik, ilgili Microsoft Learn sayfalarındaki makalelerin organizasyonuyla gevşek bir şekilde uyumludur. Alt dizinler, benzer makaleleri (hizmetler gibi), medya içeriğini (görüntü dosyaları gibi) ve "dahil etme" dosyalarını (içeriğin yeniden kullanılmasını sağlayan) ayırmak için kullanılır.

Makaleler alt dizini

Bir ana articles dizinini genellikle deponun kökünde bulabilirsiniz. Dizinarticles, .md uzantısını kullanan Markdown dosyaları olarak biçimlendirilen alt dizinlerdeki Makaleler adlı bir alt dizin kümesi içerir. Birden fazla hizmeti destekleyen bazı depolar, genel bir /articles alt dizini kullanır, örneğin Azure-Docs deposu. Diğerleri ise hizmete özgü bir ad kullanabilir, örneğin /IntuneDocs kullanan Intune-Docs deposu.

Bu dizinin kökünde, hizmet veya ürünün geneliyle alakalı makaleler bulabilirsiniz. Genelde özellikler/hizmetler veya yaygın senaryolarla eşleşen başka bir alt dizinler serisi bulabilirsiniz. Örneğin Azure “sanal makine” makaleleri /virtual-machines alt dizininde, “anlama ve keşfetme” makaleleri ise /understand-explore alt dizininde yer alır.

Medya alt dizini

Her makale dizini, karşılık gelen medya dosyaları için bir /media alt dizini içerir. Medya dosyaları, görüntü başvuruları bulunan makaleler tarafından kullanılan görüntüler içerir.

Eklemeler alt dizini

İki ya da daha fazla makale tarafından paylaşılan yeniden kullanılabilir içerik olduğunda, bu içerikler ana /includes dizininden alınan bir articles alt dizinine yerleştirilir. Ekleme dosyasını kullanan Markdown dosyasında, ekleme dosyasına başvurulması gereken konuma karşılık gelen bir “ekleme” Markdown uzantısı yerleştirilir.

Ek yönergeler için bkz . Markdown başvurusu: Ekler .

Markdown dosyası şablonu

Kolaylık sağlamak için her deponun kök dizini genellikle template.md adlı bir Markdown şablon dosyası içerir. Depoya göndermek üzere yeni bir makale oluşturmanız gerekirse "başlangıç dosyası" olarak bu şablonu kullanabilirsiniz. Bu dosya şunları içerir:

  • Dosyanın üst kısmında iki adet 3 kısa çizgi ile gösterilen bir meta veri üst bilgisi. Makaleyle ilgili izleme bilgileri için kullanılan çeşitli etiketleri içerir. Makale meta verileri yazar alıntısı, katılımcı alıntısı, içerik haritaları ve makale açıklamaları gibi belirli işlevleri etkinleştirir. Ayrıca, SEO iyileştirmeleri ve Microsoft’un içerik performansını değerlendirmek için kullandığı raporlama işlemlerini içerir. Bu nedenle meta veriler önemlidir!
  • Çeşitli meta veri etiketleri ve değerlerinin açıklandığı meta veriler bölümü. Meta veri bölümü için kullanılacak değerlerden emin değilseniz bölümü boş bırakabilirsiniz veya başına (#) diyez etiketi koyarak yorumlayabilirsiniz, bunlar daha sonra depo için çekme isteğini gözden geçiren tarafından incelenir/tamamlanır.
  • Bir makalenin öğelerini biçimlendirmeye yönelik çeşitli Markdown kullanım örnekleri.
  • Çeşitli uyarı türleri için kullanabileceğiniz, Markdown uzantılarının kullanılması ile ilgili genel talimatlar.
  • iframe kullanarak video ekleme örnekleri.
  • Düğmeler ve seçiciler gibi özel denetimler için kullanabileceğiniz Microsoft teknik belge uzantılarının kullanımıyla ilgili genel yönergeler.

Kaynak

Bu terim, yerel deponuzla kopyalandığı depo arasındaki bağlantıya atanan addır. Microsoft Learn iş akışında kaynak, çatalınızla bağlantıyı temsil eder. Bu terim bazen "Değişikliklerinizi kaynak depoya göndermeyi unutmayın" bölümünde olduğu gibi kaynak deponun kendisi için bir ad olarak kullanılır.

Çekme istekleri

Çekme isteği (PR), içerik sahibinin değişikliklerinizi resmi kaynağa çekme isteğidir. Çekme isteği, çalışma dalınızdaki değişikliklerin (işlemeler olarak da bilinir) çekilmesini ve başka bir dalda birleştirilmesini isteyerek GitHub'ın işbirliği modelini etkinleştirir. Çoğu durumda, bu diğer dal ana depodaki varsayılan daldır.

Çekme isteği, katkıda bulunana Microsoft Learn'ün doğrulama işlemlerinden geri bildirim sağlayan bir mekanizma ve değişiklikler varsayılan dalla birleştirilmeden önce sorunları veya soruları çözmek için çekme isteği gözden geçirene bir mekanizma görevi görür.

Uzaktan

Uzak, "kaynak" veya "yukarı akış" uzak gibi uzak bir depoya adlandırılmış bir bağlantıdır. Git, başka bir bilgisayarda barındırılan bir depoya başvurmak için kullanıldığından bunu uzak olarak ifade eder. Microsoft Learn iş akışında uzak her zaman bir GitHub deposudur.

Üretim öncesi

Çıkış noktası uzakı gibi yukarı akış da başka bir depoya adlandırılmış bir bağlantıdır. Microsoft Learn iş akışında yukarı akış, yerel deponuzla çatalınızın oluşturulduğu ana depo arasındaki bağlantıyı temsil eder. Bu terim bazen yukarı akış deposunun kendisi için "Yukarı akıştan en son değişiklikleri çekmeyi unutmayın" gibi bir ad olarak kullanılır.

Daha fazla bilgi edinin

Git veya GitHub'ı bilmiyorsanız, bu kaynaklar öğrenmenize, üretken olmanıza veya soruları yanıtlamanıza yardımcı olabilir.

Git kaynak denetimi kaynakları

GitHub kaynakları

SSS

Git nedir?

Git, birçok kişi bilgisayar kodu üzerinde birlikte çalıştığında değişiklikleri izlemeye yardımcı olur. Kod için bir zaman makinesi gibidir, böylece nelerin değiştiğini görebilir ve gerekirse geri dönebilirsiniz.

Git neden kullanılır?

Ekip çalışması için harika. Git, birçok kişinin birbirinin işini bozmadan aynı projede çalışmasını kolaylaştırır. Ayrıca hataları kolayca düzeltmeye yardımcı olur.

Git nasıl çalışır?

Git, proje kodunun tüm sürümlerini depolar. Değişiklik yaptığınızda Git, farklı olanın resmini (anlık görüntü gibi) çeker. Sorunsuz bir şekilde aynı anda farklı sürümler oluşturabilirsiniz.

Git'teki dallar nelerdir?

Dallar bir projedeki farklı yollar gibidir. Ana projeyi değiştirmeden insanların yeni şeyler üzerinde çalışmasına izin verir. Daha sonra bu değişiklikleri ana projeye geri getirebilirler.

Git'te işleme nedir?

İşleme, kaydetme noktası gibidir. Yaptığınız değişiklikleri kaydetmenin bir yoludur. Her işleme benzersiz bir kimliğe ve nelerin değiştirildiğine ilişkin bir nota sahiptir.

GitHub nedir?

GitHub, Git projelerinizi depolayabileceğiniz bir web sitesidir. Başkalarıyla kod paylaşmak ve kod üzerinde birlikte çalışmak için büyük bir merkez gibidir. Ayrıca kimin neyi değiştirdiğini takip etmenize de yardımcı olur.

GitHub'ın Git'ten farkı nedir?

Git, değişiklikleri izleme aracıdır, GitHub ise projelerinizi depolamak ve birlikte çalışmak için kullanabileceğiniz yerdir. GitHub, sihrini yapmak için Git'i kullanır.

GitHub ücretsiz mi?

Evet, herkesin görebileceği projeler için. Ancak özel projeler için (yalnızca siz ve ekibiniz) ödeme yapmanız gerekebilir. Ek özelliklere sahip farklı planlar sunarlar.

GitHub'da çekme istekleri nelerdir?

Çekme istekleri, değişikliklerinizi ana projeye eklemek gibidir. Kişiler eklemeden önce değişiklikleri gözden geçirebilir ve tartışabilirsiniz.

GitHub ne kadar güvenli?

GitHub, güvenlikle çok iyi ilgilenir. Özel kodları ve kuralları kullanarak yalnızca doğru kişilerin kodunuzla erişip bunları değiştirediğinden emin olurlar. Daha fazla güvenlik için iki öğeli kimlik doğrulaması gibi ek güvenlik katmanları da ekleyebilirsiniz.