Del via

Grundlæggende oplysninger om Git og GitHub til Microsoft Learn-dokumentation

  • Artikel

Oversigt

Som bidragyder til Microsoft Learn-dokumentationen interagerer du med flere værktøjer og processer. Du arbejder parallelt med andre bidragydere på det samme projekt, og muligvis også på nøjagtigt det samme indhold og endda på samme tid. Git- og GitHub-softwaren gør dette muligt.

Git er et open source-system til versionsstyring. Det muliggør denne type projektsamarbejde gennem distribueret versionsstyring af filer, der lever i lagre. Git integrerer ganske enkelt strømme af arbejde fra forskellige bidragydere over tid for et givet lager.

GitHub er en webbaseret hostingtjeneste til Git-lagre, f.eks. dem, der bruges til at gemme Microsoft Learn-indhold . Alle projekter har et centralt lager på GitHub, så bidragydere kan oprette kopier til deres eget arbejde.

Denne artikel definerer nøgleord, der er en del af Microsoft Learn-arbejdsprocessen. Den indeholder også en oversigt over Git- og GitHub-lagre og forklarer, hvordan indhold er organiseret til teknisk dokumentation fra Microsoft.

Gren

Forgreninger adskiller arbejdsstrømme (typisk kaldet versioner). Bidrag og bidragsomfang oprettes altid til en bestemt forgrening.

Ved at isolere relaterede ændringer til en bestemt forgrening kan du styre og introducere disse ændringer uafhængigt af hinanden. Afhængigt af dine opgaver kan du i praksis nemt have flere aktive arbejdsforgreninger i dit lager. Det er ikke ualmindeligt at arbejde på flere forgreninger, som alle repræsenterer selvstændige projekter, samtidigt.

Alle lagre indeholder en standardforgrening (typisk kaldet "hoved") og en eller flere igangværende forgreninger (som vi kalder arbejdsforgreninger), som endnu ikke er integreret i standardforgreningen. Standardgrenen fungerer som den aktuelle version og "enkelt kilde til sandhed" for projektet. Den er den stamme, som alle lagerets øvrige forgreninger oprettes ud fra.

Hver gang du introducerer et nyt sæt logisk relaterede ændringer, er det bedste praksis at oprette en arbejdsgren for at administrere dine ændringer. Vi anbefaler ikke, at du foretager ændringer af standardgrenen direkte.

Fork

Dette ord bruges normalt som et navneord, når der henvises til en kopi af et hovedlager i GitHub. I praksis er en kopi blot endnu et lager. Men det særlige ved en kopi er, at den bevarer en forbindelse tilbage til det centrale/overordnede lager i GitHub. Dette ord bruges nogle gange som et verbum, som i "Du skal kopiér lageret først".

Git

Hvis du har kendskab til centraliserede versionsstyringssystemer (f.eks. Team Foundation Server, SharePoint eller Visual Source Pengeskab), vil du bemærke, at Git har en unik arbejdsproces og terminologi for bidrag, der understøtter den distribuerede model. Der er f.eks. ingen fillåsning, der normalt er knyttet til udtjeknings-/indtjekningshandlinger. Git er i stedet bekymret over ændringer på et endnu finere niveau og sammenligner filer byte byte.

Git har også en niveauinddelt struktur til lagring og administration af indhold for et projekt:

  • Lager: Også kaldet et repository, er den største lagringsenhed. Et lager indeholder en eller flere forgreninger.
  • Forgrening: En lagerenhed med de filer og mapper, der udgør et projekts indholdssæt. Du kan få mere at vide om forgreninger i afsnittet Forgrening i denne artikel.

Bidragydere bruger Git til at opdatere og manipulere lagre både lokalt og på GitHub-niveauer:

  • Lokalt ved hjælp af værktøjer, som Git Bash-konsollen, der understøtter Git-kommandoer til administration af lokale lagre og kommunikation med GitHub-lagre.
  • Via www.github.com, som integrerer Git til at administrere afstemning af bidrag, som flyder tilbage til det centrale lager.

GitHub

Bemærk

Selvom dokumentationsvejledningen er baseret på brug af GitHub, bruger nogle teams Visual Studio Team Services til at hoste Git-lagre. Visual Studio Team Explorer-klienten har en grafisk brugergrænseflade til interaktion med Team Services-lagre som et alternativ til at bruge Git-kommandoer via en kommandolinje.
Mange af følgende retningslinjer blev også udviklet som bedste praksis fra mange års erfaring med at hoste Azure-tjenesteindhold i GitHub. De kan være påkrævet i nogle Microsoft Learn-lagre.

Alle arbejdsprocesser starter og slutter på GitHub-niveauet, hvor det primære lager for et hvilket som helst dokumentationsprojekt er gemt. De kopier, som bidragydere opretter til eget brug, distribueres på tværs af computere. Kopierne afstemmes til sidst med projektets centrale GitHub-lager.

Organisering af mapper

Et projekts standardgren fungerer som den aktuelle version af indholdet for projektet. Indholdet i standardforgreningen – og forgreninger, der er oprettet ud fra den – er løst justeret i forhold til organiseringen af artiklerne på de tilsvarende Microsoft Learn-sider. Undermapper bruges til at adskille artikler (f.eks. tjenester), medieindhold (f.eks. billedfiler) og "include"-filer (hvilket muliggør genbrug af indhold).

Undermappe til artikler

En central articles-mappe findes typisk i roden af lageret. Mappen articles indeholder et sæt undermapper Artikler i undermapperne er formateret som Markdown-filer, der bruger filtypenavnet .md . Nogle lagre, som understøtter flere tjenester, bruger en generisk /articles-undermappe, f.eks. Azure-Docs-lageret. Andre bruger muligvis et tjenestespecifikt navn, f.eks. IntuneDocs-lageret, som bruger /IntuneDocs.

I roden af denne mappe kan du finde generelle artikler om den overordnede tjeneste eller produktet. Du kan typisk også finde en række andre undermapper svarende til funktionerne/tjenesterne eller almindelige scenarier. Artiklen om den "virtuelle maskine" i Azure findes f.eks. i undermappen /virtual-machines, og artikler om at forstå og udforske Intune findes i undermappen /understand-explore.

Medieundermappe

Alle mapper med artikler har en /media-undermappe til tilhørende mediefiler. Mediefiler indeholder billeder, som bruges i artikler med referencer til billeder.

Medtagelse af undermapper

Alt indhold, der skal genbruges og deles på tværs af to eller flere artikler, placeres i en /includes-undermappe uden for den centrale articles-mappe. Der oprettes en "include"-udvidelse for referencepunktet i Markdown-filen, der bruger "include"-filen.

Se Markdown-reference: Indeholder for at få yderligere vejledning.

Skabelon for Markdown-filer

Af praktiske grunde indeholder rodmappen for hvert lager typisk en Markdown-skabelonfil med navnet template.md. Du kan bruge skabelonfilen som "startfil", hvis du vil oprette en ny artikel, der skal sendes til lageret. Filen indeholder følgende:

  • En -metadataoverskrift øverst i filen, afgrænset af to linjer med tre bindestreger. Den indeholder de forskellige koder, der bruges til at spore oplysninger i relation til artiklen. Artikelmetadata muliggør visse funktioner, f.eks. forfattere, bidragydere, brødkrummer og artikelbeskrivelser. De indeholder også SEO-optimering og -rapporteringsprocesser, som Microsoft anvender til at vurdere indholdets effektivitet. Så metadata er vigtige!
  • Et metadataafsnit, som beskriver de forskellige metadatakoder og -værdier. Hvis du er usikker på, hvilke værdier der skal bruges i metadataafsnittet, kan du lade dem være tomme eller kommentere dem med et foranstillet hashtag (#), som derefter gennemgås af validatoren for lagerets pullanmodninger.
  • Forskellige eksempler på at bruge Markdown til at formatere elementer i en artikel.
  • Generelle instruktioner i brugen af Markdown-udvidelser, som du kan bruge til forskellige typer beskeder.
  • Eksempler på at integrere video ved hjælp af en iframe.
  • Generelle instruktioner om brugen af Microsofts udvidelser til teknisk dokumentation, som du kan bruge til særlige kontrolelementer, f.eks. knapper og selektorer.

Original

Dette ord er det navn, der er tildelt forbindelsen mellem dit lokale lager og det lager, hvorfra det blev klonet. I Microsoft Learn-arbejdsprocessen repræsenterer oprindelsen forbindelsen til din kopi. Dette ord bruges nogle gange som en moniker for selve oprindelseslageret, som i "Husk at overføre dine ændringer til oprindelsen".

Pullanmodninger

En pullanmodning er en anmodning om, at en indholdsejer trækker dine ændringer ind i den officielle kilde. En pullanmodning muliggør GitHubs samarbejdsmodel ved at bede om, at ændringerne (også kaldet bekræftelser) fra din arbejdsgren trækkes og flettes til en anden forgrening. I de fleste tilfælde er den anden forgrening standardgrenen i hovedlageret.

En pullanmodning fungerer også som en mekanisme til at give bidragyderen feedback fra Microsoft Learn's valideringsprocesser og pr-korrekturlæseren for at løse problemer eller spørgsmål, før ændringerne flettes til standardforgreningen.

Fjernbetjening

En fjernforbindelse er en navngiven forbindelse til et fjernlager, f.eks. "oprindelse" eller "upstream"-fjern. Git refererer til dette som en fjernforbindelse, fordi det bruges til at referere til et lager, der hostes på en anden computer. I Microsoft Learn-arbejdsprocessen er en fjernforbindelse altid et GitHub-lager.

Upstream

På samme måde som den eksterne oprindelse er upstream en navngiven forbindelse til et andet lager. I Microsoft Learn-arbejdsprocessen repræsenterer upstream forbindelsen mellem dit lokale lager og det primære lager, som kopien blev oprettet fra. Dette ord bruges nogle gange som en moniker for selve upstreamlageret, som i "Husk at hente de seneste ændringer fra upstream".

Flere oplysninger

Hvis du ikke kender Git eller GitHub, kan disse ressourcer hjælpe dig med at lære, være produktiv eller besvare spørgsmål.

Git-ressourcer til kildekontrol

GitHub-ressourcer

Ofte stillede spørgsmål

Hvad er Git?

Git hjælper med at holde styr på ændringer, når mange arbejder med computerkode sammen. Det er som en tidsmaskine til kode, så du kan se, hvad der er ændret, og gå tilbage, hvis det er nødvendigt.

Hvorfor bruge Git?

Det er fantastisk til teamwork. Git gør det nemt for mange personer at arbejde på det samme projekt uden at ødelægge hinandens arbejde. Det hjælper også nemt at rette fejl.

Hvordan fungerer Git?

Git gemmer alle versioner af et projekts kode. Når du foretager ændringer, tager Git et billede (f.eks. et snapshot) af, hvad der er anderledes. Du kan oprette forskellige versioner på samme tid uden problemer.

Hvad er forgreninger i Git?

Forgreninger er som forskellige stier i et projekt. De lader folk arbejde på nye ting uden at ændre hovedprojektet. Senere kan de hente disse ændringer tilbage til hovedprojektet.

Hvad er en bekræftelse i Git?

En bekræftelse er som et lagringspunkt. Det er en måde at registrere ændringer på. Hver bekræftelse har et entydigt id og en note om, hvad der blev ændret.

Hvad er GitHub?

GitHub er et websted, hvor du kan gemme dine Git-projekter. Det er som en stor hub til deling og samarbejde om kode med andre. Det hjælper også med at holde styr på, hvem der ændrede hvad.

Hvordan adskiller GitHub sig fra Git?

Git er værktøjet til sporing af ændringer, mens GitHub er stedet, hvor du kan gemme dine projekter og arbejde sammen. GitHub bruger Git til at udføre sin magi.

Er GitHub gratis?

Ja, for projekter, som alle kan se. Men for private projekter (kun dig og dit team) skal du muligvis betale. De tilbyder forskellige planer med ekstra funktioner.

Hvad er pullanmodninger i GitHub?

Pullanmodninger er som at bede om at placere dine ændringer i hovedprojektet. Mennesker kan gennemse og diskutere ændringerne, før de tilføjes.

Hvor sikker er GitHub?

GitHub tager sig godt af sikkerheden. De bruger særlige koder og regler til at sikre, at kun de rette personer kan få adgang til og ændre din kode. Du kan også tilføje ekstra sikkerhedslag som tofaktorgodkendelse for at øge sikkerheden.