Gjør store endringer i Dokumentasjon for Microsoft Learn

Artikkel
02/01/2024

Viktig

Alle repositorier som publiserer til Microsoft Learn, har tatt i bruk enten Microsoft Open Source Code of Conduct eller .NET Foundation Code of Conduct. Hvis du vil ha mer informasjon, se Vanlige spørsmål om regler for god opptreden. Eller kontakt opencode@microsoft.com, eller conduct@dotnetfoundation.org med eventuelle spørsmål eller kommentarer.

Mindre rettelser eller avklaringer i dokumentasjon og kodeeksempler i offentlige repositorier dekkes av learn.microsoft.com vilkår for bruk. Eventuelle endringer genererer en kommentar i pull-forespørselen, og ber deg om å sende inn en lisensavtale for bidrag på nettet (CLA) hvis du ikke er ansatt hos Microsoft. Du må fylle ut det elektroniske skjemaet før pull-forespørselen kan slås sammen.

Denne artikkelen viser deg hvordan du endrer en Microsoft Learn-artikkel ved hjelp av lokale verktøy og er egnet for en bidragsyter som trenger å gjøre store endringer eller vil være en hyppig bidragsyter til et repositorium. Hyppige bidragsytere har vanligvis pågående eller langvarige endringer som går gjennom flere bygg-/validerings-/oppsamlingssykluser eller strekker seg over flere dager før de logger av på pull-forespørselen (PR).

Eksempler på denne typen bidrag inkluderer:

Gjøre et stort bidrag. Bidragene dine (tillegg, endringer eller slettinger) kan for eksempel omfatte flere artikler og må utføres og testes som én arbeidsenhet i én enkelt PR.
Opprette og publisere en ny artikkel, som vanligvis krever et mer robust lokalt redigeringsprogram.
Legge til nye bilder eller oppdatere bilder, som vanligvis krever at du oppretter en ny media underkatalog samtidig, oppretter bildefiler, oppdaterer bildekoblinger i artikler og forhåndsviser Markdown-filer i et lokalt redigeringsprogram for å teste bildegjengivelse.
Oppdatere en artikkel over en periode på flere dager før du publiserer. I disse tilfellene må du vanligvis utføre regelmessig integrering av andre endringer som skjer i standardgrenen. Denne integrasjonen er enklere via Git Bash og lokal redigering. Du risikerer også å miste endringene hvis du gjør dette via GitHub-nettredigeringsprogrammet og venter før du utfører endringene.
Foreta kontinuerlige oppdateringer av den samme artikkelen etter at en pr er åpnet. Selv om du kan bruke GitHub-redigeringsprogrammet for dette formålet, kan du opprette flere utestående PC-er for samme fil, som kan komme i konflikt med hverandre.

Forutsetning

Identifiser GitHub-repositoriet som lagrer dokumentasjonen du vil redigere.
Opprett en GitHub-konto hvis du ikke har en.
Installer Git- og Markdown-verktøy.
Konfigurere et lokalt Git-repositorium.
Se gjennom grunnleggende om Git og GitHub (valgfritt).

Opprette og sjekke ut arbeidsgrenen

Du kan begynne med å opprette en ny arbeidsgren i det lokale repositoriet for å registrere de foreslåtte endringene. Hvis du vil ha mer bakgrunn på grener, kan du se grunnleggende om Git og GitHub.

Denne opplæringen bruker Git Bash og Visual Studio Code, men du kan bruke hvilken som helst Git-klient og -redigeringsprogram du foretrekker.

Åpne repositoriummappen for den lokale klone i VS Code. Velg Åpne mappe på Fil-menyen, og gå til mappen på maskinen.
Velg Vis fra den øverste menyen, og velg deretter Terminal for å åpne den integrerte terminalen.
Kontroller at du er i repositoriummappen i den integrerte terminalen.
Før du oppretter en arbeidsgren, må du kontrollere at den lokale hovedgrenen er oppdatert med alt i hovedgrenen til produksjonsdepoen. Denne oppgaven sikrer at arbeidsgrenen registrerer eventuelle endringer som har skjedd i produksjonsrepo siden forrige gang du synkroniserte med den.
1. Bytt til hovedgrenen i det lokale repositoriet:
```
git checkout main 
```
2. Sørg for at den lokale hovedgrenen er oppdatert:
```
git pull upstream main 
```
Opprett en lokal arbeidsgren basert på hoved:
```
git checkout -b <branch-name>
```
<branch-name> er en plassholder. Når du kjører kommandoen, erstatter du den med et unikt og meningsfylt navn for grenen og fjerner vinkelparentesene.
Skyv den lokale arbeidsgrenen til den eksterne grenen i GitHub-forgreningen:
```
git push origin <branch-name> -u
```
Alternativet -u kobler sammen lokale og eksterne grener. Med dette alternativet kan du sende utføringer til forgreningen ved å skrive inn bare git push i stedet git push origin <branch-name>for .

Finn markdown-kildefilen

Hvis du vil redigere en artikkel, finner du kildefilen for artikkelen i det lokale repositoriet. I VS Code får du tilgang til markdown-filene for repo via filutforskeren (et dokumentikon øverst til venstre). Filutforskeren viser mappestrukturen for repo, og du kan navigere til filen du vil redigere.

Hvis du ikke finner filen, kan du gå til artikkelen på Microsoft Learn og velge Rediger blyant-ikonet. Den relative mappeplasseringen i GitHub-repositoriet vises i nettadressen. Her er et eksempel på rediger url-adresse for kobling:

   https://github.com/Microsoft/azure-docs/blob/main/articles/azure-functions/functions-overview.md

Her er et eksempel på en filplassering for denne URL-adressen.

   C:\GitHub\*\azure-docs\articles\azure-functions\functions-overview.md

Rediger filen

Åpne filen i VS Code ved å velge den.
Gjør endringene.
Lagre endringene ved å velge Fillagring>. Bruk Lagre alle til å lagre flere filer samtidig.

Utfør og trykk på endringene

Hvis du har gjort betydelige endringer eller gjennomgått en artikkel for nyhet, kan du oppdatere ms.date i metadatablokken øverst i filen. Formater datoen som mm/dd/åååå.

Du kan bruke VS Code-terminalen eller VS Code-brukergrensesnittet til å utføre og sende endringene.

VS Code Terminal
VS Code UI

git status Kjør kommandoen for å bekrefte at bare filene du redigerte, vises i listen over endrede filer.
```
git status
```
git add Kjør kommandoen etterfulgt av filbanen og filnavnet for å iscenesette filen du endret.
```
git add folder-name/file-name.md
```
Hvis du har endret flere filer, skriver du inn en git add kommando for hver fil.

Du kan også kjøre git add . (legg merke til perioden etter add) for automatisk å utføre alle endringene du har gjort. Denne metoden er raskere, men kan forårsake problemer ved å inkludere endringer du har gjort ved et uhell.
Kjør git status på nytt for å bekrefte hvilke endringer som ble iscenesatt.
git commit Kjør kommandoen etterfulgt av en utføringsmelding for å lagre endringene i det lokale klonede repositoriet.
```
git commit -m "your commit message"
```
Kjør git push for å sende endringene.
```
git push
```

Du kan opprette og sende en utføring ved hjelp av Git-integreringsfunksjonene i VS Code. Husk å fortsette arbeidet på samme maskin. Hvis du bytter maskin, har du ikke den nyeste versjonen av arbeidsgrenen å fortsette med.

Kontroller at det lokale repo fortsatt har den samme arbeidsgrenen sjekket ut. Grenen vises nederst i venstre hjørne i VS Code-brukergrensesnittet. Grennavnet fungerer også som en knapp for å bytte grener.
Velg forgreningsverktøyet i VENSTRE VS-kode for å se kildekontrollen : Git-ruten .

Filen du redigerte, vises under Endringer med en M til høyre for å angi at den er endret. Nye filer vises med en U (usporet), og slettede filer vises med en D.
Fase endringene. Hold pekeren over Endringer-linjen til et + ikon vises. Velg dette ikonet. Denne handlingen tilsvarer git add kommandoen. Filen vises nå i delen Trinnvise endringer .
Skriv inn en utføringsmelding, for eksempel «oppdater metadatadato» i meldingstekstboksen , og merk av.
Trykk på utføringen. Velg Knappen Synkroniser endringer som vises under utføringsmeldingsblokken.

Du har gjort det! Koden er nå oppe i GitHub-repositoriet og er klar til å åpne en PR.

Trenger du å fikse noe du sendte inn? Det er enkelt! Bare gjenta trinnene ovenfor, fra og med Rediger filen, for å gjøre endringer i samme gren og deretter utføre og skyve på nytt (du trenger ikke å sette oppstrømsserveren på etterfølgende push-er av samme gren). Vanligvis brukes grener til å skille strømmer av arbeid, så du trenger ikke å opprette en ny gren med mindre du er klar til å arbeide med noe annet.

Gjør neste endring

Klar til å gjøre en ny endring, ikke relatert til denne? Bytt tilbake til standardgrenen, dra fra oppstrømsrepositoriet for å oppdatere forgreningen, og sjekk ut en ny gren. Kjør følgende kommandoer i Git Bash:

git checkout main
git pull upstream main
git checkout -b "branchname"
git push origin <branch-name> -u

Du er nå i en ny gren som er koblet til den eksterne grenen, og du er klar til å gjøre flere endringer. Du er godt på vei til å bli en ekspert bidragsyter!

Neste trinn

Hvis du har fullført trinnene ovenfor, er det nå på tide å åpne en pr for å få endringene slått sammen til hovedgrenen.
Hvis du vil lære mer om emner som Markdown og Markdown-utvidelsessyntaks, kan du se markdown-referansen.