Foretag større ændringer i dokumentationen til Microsoft Learn

Vigtigt

Alle lagre, der publicerer til Microsoft Learn, har enten vedtaget Ordensreglerne for Microsoft Open Source eller .NET Foundation Code of Conduct. Se Ofte stillede spørgsmål om ordensregler for at få flere oplysninger. Du er også velkommen til at kontakte opencode@microsoft.com eller conduct@dotnetfoundation.org, hvis du har spørgsmål eller kommentarer.

Mindre rettelser eller præciseringer af dokumentation og kodeeksempler i offentlige lagre er omfattet af learn.microsoft.com Vilkår for anvendelse. Eventuelle ændringer genererer en kommentar i pullanmodningen, hvor du bliver bedt om at indsende en online cla-aftale (Contribution License Agreement), hvis du ikke er ansat hos Microsoft. Du skal udfylde onlineformularen, før pullanmodningen kan flettes.

I denne artikel kan du se, hvordan du ændrer en Microsoft Learn-artikel ved hjælp af lokale værktøjer og er velegnet til en bidragyder, der har brug for at foretage en større ændring eller vil være en hyppig bidragyder til et lager. Hyppige bidragydere har typisk løbende eller langvarige ændringer, der gennemgår flere build/validering/midlertidige cyklusser eller strækker sig over flere dage, før de logger af på deres pullanmodning.

Eksempler på disse typer bidrag omfatter:

• Ydelse af et stort bidrag. Dine bidrag (tilføjelser, ændringer eller sletninger) kan f.eks. strække sig over flere artikler og skal bekræftes og testes som én arbejdsenhed i en enkelt pullanmodning.
• Oprettelse og udgivelse af en ny artikel, hvilket typisk kræver en mere robust lokal editor.
• Tilføjelse af nye billeder eller opdatering af billeder, hvilket typisk kræver, at du opretter en ny media undermappe samtidig, opretter billedfiler, opdaterer billedlinks i artikler og får vist Markdown-filer i en lokal editor for at teste billedgengivelse.
• Opdatering af en artikel, der strækker sig over flere dage, før den udgives. I disse tilfælde skal du typisk udføre regelmæssig integration af andre ændringer, der forekommer i standardgrenen. Denne integration er lettere at udføre via Git Bash og lokal redigering. Du risikerer også at miste dine ændringer, hvis du gør dette via GitHub-webeditoren og venter, før du foretager ændringerne.
• Foretage løbende opdateringer af den samme artikel, når en pullanmodning er blevet åbnet. Selvom du kan bruge GitHub-webeditoren til dette formål, kan du oprette flere udestående pullanmodninger for den samme fil, hvilket kan være i konflikt med hinanden.

Forudsætninger

• Identificer det GitHub-lager, der gemmer den dokumentation, du vil redigere.
• Opret en GitHub-konto, hvis du ikke har en.
• Installér Git- og Markdown-værktøjer.
• Konfigurer et lokalt Git-lager.
• Gennemse grundlæggende oplysninger om Git og GitHub (valgfrit).

Opret og tjek din arbejdsgren

Hvis du vil starte, skal du oprette en ny arbejdsgren i dit lokale lager for at registrere dine foreslåede ændringer. Du kan få mere at vide om forgreninger under Grundlæggende om Git og GitHub.

I dette selvstudium bruges Git Bash og Visual Studio Code, men du kan bruge en hvilken som helst Git-klient og -editor, du foretrækker.

1. Åbn lagermappen for din lokale klon i VS Code. Vælg Åbn mappe i menuen Filer, og naviger til mappen på computeren.

2. Vælg Vis i den øverste menu, og vælg derefter Terminal for at åbne den integrerede terminal.

3. I den integrerede terminal skal du sørge for, at du er i lagermappen.

4. Før du opretter en arbejdsgren, skal du sørge for, at din lokale hovedgren er aktuel med alt i produktionsobjektets hovedgren. Denne opgave sikrer, at din arbejdsgren registrerer eventuelle ændringer, der er sket i produktionsrepoet siden sidste gang, du synkroniserede med det.

   1. Skift til hovedgrenen i dit lokale lager:

      git checkout main 
      

   2. Sørg for, at din lokale hovedgren er aktuel:

      git pull upstream main 
      

5. Opret en lokal arbejdsgren baseret på hovedlinjen:

   git checkout -b <branch-name>
   

   <branch-name> er en pladsholder. Når du kører kommandoen, skal du erstatte den med et entydigt og sigende navn for din forgrening og fjerne vinkelparenteser.

6. Send den lokale arbejdsgren til fjern-forgreningen i din GitHub-kopi:

   git push origin <branch-name> -u
   

   Indstillingen -u linker de lokale og eksterne forgreninger. Denne indstilling giver dig mulighed for at push-bekræftelser til din kopi ved kun git push at angive i stedet for git push origin <branch-name>.

Find Markdown-kildefilen

Hvis du vil redigere en artikel, skal du finde kildefilen til artiklen i din lokale lagerklone. I VS Code skal du få adgang til lagerets Markdown-filer via Stifinder (et dokumentikon i margenteksten øverst til venstre). Stifinder viser lagerets mappestruktur, og du kan navigere til den fil, du vil redigere.

Hvis du ikke kan finde filen, skal du gå til artiklen i Microsoft Learn og vælge blyantsikonet Rediger . Den relative mappeplacering i GitHub-lageret vises i URL-adressen. Her er et eksempel på URL-adressen til rediger link:

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

Her er et eksempel på en filplacering for denne URL-adresse.

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

Rediger filen

1. Åbn filen i VS Code ved at vælge den.
2. Foretag dine ændringer.
3. Gem dine ændringer ved at vælge Gem fil>. Brug Gem alle til at gemme flere filer på én gang.

Bekræft og send dine ændringer

Hvis du har foretaget omfattende ændringer eller gennemset en artikel for at få opdateret den, skal du opdatere ms.date i metadatablokken øverst i filen. Formatér datoen som mm/dd/åååå.

Du kan bruge VS Code-terminalen eller brugergrænsefladen i VS Code til at bekræfte og pushe dine ændringer.

VS Code Terminal

1. Kør kommandoen git status for at kontrollere, at det kun er de filer, du har redigeret, der vises på listen over ændrede filer.

   git status
   

2. Kør kommandoen git add efterfulgt af filstien og filnavnet for at fase den fil, du har ændret.

   git add folder-name/file-name.md
   

   Hvis du har ændret flere filer, skal du angive en git add kommando for hver fil.

   Du kan også køre git add . (bemærk perioden efter add) for automatisk at fase alle de ændringer, du har foretaget. Denne metode er hurtigere, men kan medføre problemer ved at inkludere ændringer, du har foretaget ved et uheld.

3. Kør git status igen for at bekræfte, hvilke ændringer der er foretaget i fase.

4. Kør kommandoen git commit efterfulgt af en bekræftelsesmeddelelse for at gemme ændringerne i dit lokale klonede lager.

   git commit -m "your commit message"
   

5. Kør git push for at pushe dine ændringer.

   git push
   

Brugergrænsefladen i VS Code

Du kan oprette og pushe en bekræftelse ved hjælp af Git-integrationsfunktioner i VS Code. Husk at fortsætte dit arbejde på den samme maskine. Hvis du skifter maskine, har du ikke den nyeste version af arbejdsgrenen at fortsætte med.

1. Sørg for, at det lokale lager stadig har den samme arbejdsgren tjekket ud. I brugergrænsefladen i VS Code vises forgreningen i nederste venstre hjørne. Forgreningsnavnet fungerer også som en knap til skift af forgreninger.

   

2. I venstre margentekst for VS Code skal du vælge kopiværktøjet for at se ruden Kildekontrol: Git .

   

   Den fil, du har redigeret, vises under Ændringer med et M til højre for at angive, at den er blevet ændret. Nye filer vises med en U (ikke-sporet), og slettede filer vises med et D.

3. Iscenesat ændringerne. Hold markøren over linjen Ændringer, indtil der vises et + ikon. Vælg dette ikon. Denne handling svarer til kommandoen git add . Filen vises nu i afsnittet Faseindspilede ændringer .

4. Angiv en bekræftelsesmeddelelse, f.eks. "Opdater metadatadato" i tekstfeltet Meddelelse , og markér afkrydsningsfeltet.

   

5. Send bekræftelsen. Vælg knappen Synkroniser ændringer , der vises under bekræftelsesblokken.

   

Du har gjort det! Din kode er nu oppe i dit GitHub-lager og klar til at åbne en pullanmodning.

Har du brug for at rette noget, du har indsendt? Det er nemt! Du skal blot gentage trinnene ovenfor, startende med Rediger filen, for at foretage ændringer i den samme forgrening og derefter bekræfte og pushe igen (det er ikke nødvendigt at angive upstream-serveren på efterfølgende push for den samme forgrening). Forgreninger bruges generelt til at adskille arbejdsstrømme, så du ikke behøver at oprette en ny forgrening, medmindre du er klar til at arbejde på noget andet.

Foretag din næste ændring

Er du klar til at foretage en anden ændring, der ikke er relateret til denne? Skift tilbage til standardgrenen, træk fra upstreamlageret for at opdatere din kopi, og se en ny forgrening. Kø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 nu i en ny forgrening, der er knyttet til din eksterne forgrening, og du er klar til at foretage flere ændringer. Du er godt på vej til at blive ekspertbidragyder!

Næste trin

• Hvis du har fuldført trinnene ovenfor, er det nu tid til at åbne en pullanmodning for at få dine ændringer flettet ind i hovedgrenen.
• Du kan få mere at vide om emner som Markdown og syntaksen for Markdown-udvidelser ved at gennemse Markdown-referencen.