Del via

Git og GitHub essentials for Microsoft Learn-dokumentasjon

  • Artikkel

Oversikt

Som bidragsyter til Microsoft Learn-dokumentasjonen samhandler du med flere verktøy og prosesser. Du skal arbeide parallelt med andre bidragsytere på det samme prosjektet, potensielt nøyaktig samme innhold, til og med samtidig. Alt dettes gjøres mulig gjennom Git- og GitHub-programvare.

Git er et versjonskontrollsystem med åpen kildekode. Det gjør det denne typen prosjektsamarbeid enklere gjennom distribuert versjonskontroll av filer i repositorier. Git gjør det rett og slett mulig å integrere arbeidsstrømmer gjort av flere bidragsytere over tid for et gitt repositorium.

GitHub er en nettbasert vertstjeneste for Git-repositorier, for eksempel de som brukes til å lagre Microsoft Learn-innhold . GitHub er vert for hovedrepositoriet for ethvert prosjekt, hvorfra bidragsytere kan ta kopier av arbeidet sitt.

Denne artikkelen definerer viktige termer som er en del av Microsoft Learn-arbeidsflyten. Den gir også en oversikt over Git- og GitHub-repositorier, og forklarer hvordan innhold er organisert for Microsofts tekniske dokumentasjon.

Gren

Grener skiller arbeidsstrømmer (vanligvis kalt versjoner). Bidrag gjøres alltid og er begrenset til en bestemt gren.

Hvis du isolerer relaterte endringer i en bestemt gren, kan du kontrollere og introdusere disse endringene uavhengig av hverandre. I virkeligheten kan du, avhengig av typen arbeid du utfører, enkelt ende opp med flere arbeidsgrener i repositoriet. Det er ikke uvanlig å arbeide på flere grener på samme tid, hvor hver enkelt representerer forskjellige prosjekter.

Alle repositorier inneholder en standardgren (vanligvis kalt «hoved») og én eller flere pågående grener (som vi kaller arbeidsgrener) som ennå ikke er integrert i standardgrenen. Standardgrenen fungerer som gjeldende versjon og «enkel kilde til sannhet» for prosjektet. Det er overordnet alle andre grener i repositoriet den er opprettet fra.

Hver gang du introduserer et nytt sett med logisk relaterte endringer, er det en anbefalt fremgangsmåte å opprette en arbeidsgren for å administrere endringene. Vi anbefaler ikke å gjøre endringer i standardgrenen direkte.

Gaffel

Denne termen brukes vanligvis som substantiv når du refererer til en kopi av et hovedrepositorium for GitHub. I praksis er en forgrening bare et annet repositorium. Men det er spesielt i den forstand at GitHub beholder en kobling tilbake til det overordnede/hovedrepositoriet. Denne termen brukes noen ganger som verb, som i «Du må forgrene repositoriet først».

Git

Hvis du er kjent med sentraliserte versjonskontrollsystemer (for eksempel Team Foundation Server, SharePoint eller Visual SourceSafe), vil du legge merke til at Git har en unik bidragsarbeidsflyt og terminologi for å støtte den distribuerte modellen. Det finnes for eksempel ingen fillåsing som vanligvis er knyttet til utsjekkings-/innsjekkingsoperasjoner. I stedet er Git bekymret for endringer på et enda finere nivå, og sammenligner filer byte byte.

Git bruker også en trinnvis struktur for å lagre og behandle innhold for et prosjekt:

  • Repositorium: også kjent som et repo, dette er den høyeste lagringsenheten. Et repositorium inneholder én eller flere grener.
  • Gren: En lagringsenhet som inneholder filene og mappene som utgjør et prosjekts innholdssett. Hvis du vil ha mer informasjon om grener, kan du se grendelen av denne artikkelen.

Bidragsytere samhandler med Git for å oppdatere og manipulere repositorier både på lokale og GitHub-nivåer:

  • Lokalt gjennom verktøy som Git Bash-konsollen, som støtter Git-kommandoer for behandling av lokale repositorier og kommunikasjon med GitHub-repositorier.
  • Via www.github.com, som integrerer Git for å administrere avstemming av bidrag som flyter tilbake til hovedrepositoriet.

GitHub

Merk

Selv om dokumentasjonsveiledningen er basert på bruk av GitHub, bruker noen team Visual Studio Team Services til å være vert for Git-repositorier. Visual Studio Team Explorer-klienten gir et grafisk brukergrensesnitt for samhandling med Team Services-repositorier som et alternativ til å bruke Git-kommandoer via en kommandolinje.
Mange av følgende retningslinjer ble også utviklet som anbefalte fremgangsmåter fra mange års erfaring med å være vert for Azure-tjenesteinnhold i GitHub. De kan være nødvendige i enkelte Microsoft Learn-repositorier.

Alle arbeidsflyter begynner og slutter på GitHub-nivået, der hovedrepositoriet for alle dokumentasjonsprosjekt lagres. Kopier som bidragsytere oppretter til egen bruk, distribueres på tvers av flere datamaskiner. Disse kopiene avstemmes til slutt tilbake til prosjektets primære GitHub-repositorium.

Katalogorganisering

Standardgrenen for et prosjekt fungerer som gjeldende versjon av innhold for prosjektet. Innholdet i standardgrenen og grenene som er opprettet fra den, er løst justert med organiseringen av artiklene på de tilsvarende Microsoft Learn-sidene. Underkataloger brukes til å skille som artikler (for eksempel tjenester), medieinnhold (for eksempel bildefiler) og «inkluder»-filer (som aktiverer gjenbruk av innhold).

Underkatalog for artikler

Du finner vanligvis en articles hovedkatalog utenfor roten til repositoriet. Katalogen articles inneholder et sett med underkatalogartikler i underkatalogene er formatert som Markdown-filer som bruker filtypen MD . Noen repositorier som støtter flere tjenester bruker en generisk /articles underkatalog, som Azure-Docs-repositoriet. Andre kan bruke et tjenestespesifikt navn, for eksempel IntuneDocs-repositoriet, som bruker /IntuneDocs.

I roten i denne katalogen kan du finne generelle artikler relatert til samlet service eller produkt. Vanligvis kan du deretter finne en annen serie med underkataloger som samsvarer med funksjoner/tjenester eller vanlige scenarier. Artikler om Azure «virtuell maskin» er for eksempel i /virtual-machines-underkatalogen, og Intune «forstå og utforske»-artikler i /understand-explore-underkatalogen.

Media-underkatalog

Hver artikkelkatalog inneholder en /media-underkatalog for tilsvarende mediefiler. Mediefiler inneholder bilder som brukes av artikler som har bildereferanser.

inkluderinger-underkatalog

Når vi har innhold som er delt i to eller flere artikler, plasseres det i en /includes underkatalog av hovedkatalogenarticles. I en Markdown-fil som bruker inkluderingsfilen, plasseres en tilsvarende Markdown-utvidelse med «inkludering» der inkluderingsfilen må refereres til.

Se Markdown-referanse: Inkluderer for ytterligere veiledning.

Markdown-filmal

For enkelhets skyld, inneholder rotkatalogen til hvert repositorium typisk en Markdown-malfil kalt template.md. Du kan bruke denne malfilen som en «startfil» hvis du vil opprette en ny artikkel for sending til repositoriet. Filen inneholder:

  • En metadataoverskrift merket på toppen av filen, merket av to, 3-bindestrekslinjer. Den inneholder forskjellige koder som brukes til å spore informasjon som er relatert til artikkelen. Artikkelens metadata muliggjør visse funksjoner, for eksempel opprettertillegg, bidragsytertillegg, navigasjonssti og beskrivelser for artikkelen. Den omfatter også SEO-optimalisering og rapporteringsprosesser som Microsoft bruker til å evaluere ytelsen til innholdet. Så disse metadataene er viktige!
  • En metadata-del som beskriver de forskjellige metadata-kodene og verdiene. Hvis du er usikker på verdiene som skal brukes for metadata-inndeling, kan du la dem være tomme eller kommentere dem med en hashtag (#), og de blir gjennomgått/fullført av evaluerer for pull-forespørsel for repositoriet.
  • Ulike eksempler på bruk av Markdown for å formatere elementer i en artikkel.
  • Generelle instruksjoner om bruk av Markdown-utvidelser, som du kan bruke for ulike typer varsler.
  • Eksempler på innebygd video ved å bruke en iframe.
  • Generelle instruksjoner om bruken av Microsofts tekniske dokumentasjonsutvidelser, som du kan bruke til spesielle kontroller, for eksempel knapper og velgere.

Opprinnelse

Denne termen er navnet som er tilordnet tilkoblingen mellom det lokale repositoriet og repositoriet det ble klonet fra. I Microsoft Learn-arbeidsflyten representerer opprinnelsen tilkoblingen til forgreningen. Denne termen brukes noen ganger som en moniker for selve opprinnelsesrepositoriet, som i «Husk å sende endringene til opprinnelsen».

Pull-forespørsler

En pull-forespørsel (PR) er en forespørsel om at en innholdseier skal hente endringene til den offisielle kilden. En PR gjør det mulig for GitHubs samarbeidsmodell ved å be om at endringene (også kjent som utføringer) fra arbeidsgrenen blir trukket og slått sammen til en annen gren. I de fleste tilfeller er den andre grenen standardgrenen i hovedrepositoriet.

En pr fungerer også som en mekanisme for å gi bidragsyteren tilbakemelding fra Microsoft Learns valideringsprosesser og PR-anmelderen for å løse problemer eller spørsmål før endringene slås sammen til standardgrenen.

Eksterne

En ekstern er en navngitt tilkobling til et eksternt repositorium, for eksempel «opprinnelse»- eller «oppstrøms»-fjernkontrollen. Git refererer til dette som en fjernkontroll fordi det brukes til å referere til et repositorium som driftes på en annen datamaskin. I Microsoft Learn-arbeidsflyten er en fjernkontroll alltid et GitHub-repositorium.

Oppstrøms

I likhet med ekstern opprinnelse, er oppstrøms en navngitt tilkobling til et annet repositorium. I Microsoft Learn-arbeidsflyten representerer oppstrøms tilkoblingen mellom det lokale repositoriet og hovedrepositoriet som forgreningen ble opprettet fra. Denne termen brukes noen ganger som moniker for selve oppstrømsrepositoriet, som i «Husk å trekke de siste endringene fra oppstrøms».

Finn ut mer

Hvis du ikke er kjent med Git eller GitHub, kan disse ressursene hjelpe deg med å lære, være produktiv eller svare på spørsmål.

Git-kildekontrollressurser

GitHub-ressurser

Vanlige spørsmål

Hva er Git?

Git bidrar til å holde oversikt over endringer når mange jobber med datakode sammen. Det er som en tidsmaskin for kode, slik at du kan se hva som er endret og gå tilbake om nødvendig.

Hvorfor bruke Git?

Det er flott for teamarbeid. Git gjør det enkelt for mange å jobbe med det samme prosjektet uten å ødelegge hverandres arbeid. Det hjelper også å løse feil enkelt.

Hvordan fungerer Git?

Git lagrer alle versjonene av en prosjektkode. Når du gjør endringer, tar Git et bilde (for eksempel et øyeblikksbilde) av det som er annerledes. Du kan lage forskjellige versjoner samtidig uten problemer.

Hva er grener i Git?

Grener er som forskjellige baner i et prosjekt. De lar folk arbeide med nye ting uten å endre hovedprosjektet. Senere kan de bringe disse endringene tilbake til hovedprosjektet.

Hva er en utføring i Git?

En utføring er som et lagringspunkt. Det er en måte å registrere endringer du har gjort på. Hver utføring har en unik ID og et notat om hva som ble endret.

Hva er GitHub?

GitHub er et nettsted der du kan lagre Git-prosjektene dine. Det er som et stort knutepunkt for deling og samarbeid om kode med andre. Det bidrar også til å holde oversikt over hvem som endret hva.

Hvordan er GitHub forskjellig fra Git?

Git er verktøyet for sporing av endringer, mens GitHub er stedet der du kan lagre prosjektene og samarbeide. GitHub bruker Git til å gjøre sin magi.

Er GitHub gratis?

Ja, for prosjekter alle kan se. Men for private prosjekter (bare du og teamet ditt) må du kanskje betale. De tilbyr forskjellige planer med ekstra funksjoner.

Hva er pull-forespørsler i GitHub?

Pull-forespørsler er som å be om å sette inn endringene i hovedprosjektet. Folk kan se gjennom og diskutere endringene før de legges til.

Hvor sikker er GitHub?

GitHub tar godt vare på sikkerheten. De bruker spesielle koder og regler for å sikre at bare de riktige personene kan få tilgang til og endre koden din. Du kan også legge til ekstra sikkerhetslag som godkjenning med to faktorer for mer sikkerhet.