Del via

Rediger Microsoft Learn-dokumentasjon i nettleseren

  • Artikkel

Tips

Et trinnvis læringskurs er tilgjengelig for dette emnet.

Flere av Microsofts dokumentasjonssett er åpen kilde og driftes på GitHub. Selv om ikke alle dokumentasjonssett er helt åpen kilde, har mange offentlige repositorier der du kan foreslå endringer via pull-forespørsler (PR-er). Denne åpen kildekode-tilnærmingen effektiviserer og forbedrer kommunikasjonen mellom produktteknikere, innholdsteam og kunder.

Hurtigredigeringer gjør det enklere for prosessen å rapportere og løse små feil og utelatelser i dokumentasjonen. Til tross for at vi arbeider hardt for å unngå det,sniker det seg inn små grammatiske feil og stavefeil i dokumentene vi publiserer. Vi setter pris på din hjelp til å identifisere og løse disse problemene!

Vi bruker PR-er for alle endringer, selv for bidragsytere som har skrivetilgang. De fleste repositorier beskytter standardgrenen, så oppdateringer må derfor sendes inn som PR-er.

Forutsetning

Redigere et dokument i nettleseren

  1. Gå til dokumentasjonen du vil redigere. Noen dokumentsider tillater deg å redigere innhold direkte i nettleseren. I så fall ser du et rediger blyantikon som det som vises nedenfor. Når du velger Rediger blyant-ikonet, kommer du til kildefilen på GitHub.

    Skjermbilde av en azure-dokumentasjonsartikkel som viser blyantikonet **Rediger**.

    Hvis Rediger blyant-ikonet ikke finnes, betyr det at innholdet ikke er åpent for offentlige bidrag. Noen sider genereres (for eksempel fra innebygd dokumentasjon i kode) og må redigeres i prosjektet de tilhører.

  2. Velg Rediger blyant-ikonet øverst på GitHub-filsiden. Hvis Rediger blyant-ikonet er utilgjengelig (vises nedtonet) eller ikke vises, må du logge på GitHub-kontoen.

    Skjermbilde av Azure-artikkelen i GitHub, som viser blyantikonet **Rediger**.

    Øverst i artikkelen finner du artikkelens metadata. Metadata brukes på artikler for rapportering, synlighet via søk og kjøring av aspekter ved nettstedsopplevelsen. Hvis du gjør mindre oppdateringer i en publisert artikkel, trenger du sannsynligvis ikke å endre metadataene.

  3. Hvis det er første gang du arbeider i dette repositoriet, blir du bedt om å forgrene repositoriet før du foreslår endringer. Velg Fork for dette repositoriet for å fortsette.

  4. Rediger filen i nettredigeringsprogrammet. Velg Forhåndsvisning-fanen på verktøylinjen for å kontrollere formateringen av endringene.

  5. Når du er ferdig med å redigere, velger du Knappen Utfør endringer eller Foreslå endringer , vanligvis øverst til høyre på skjermen.

  6. Skriv inn en utføringsmelding. Utføringsmeldingen blir tittelen på pr og bør være et kort sammendrag av endringene (for eksempel «Løse stave- og grammatikkfeil»). Du kan også legge til en utvidet beskrivelse for å gi mer informasjon om endringene. Velg Foreslå endringer:

    Skjermbilde av hurtigmenyen foreslå endringer.

  7. Nå som du har foreslått og utført endringene dine, må du be eierne av repositoriet om å «trekke» endringene inn i repositoriet. Dette gjøres ved hjelp av en pull-forespørsel (PR). Når du velger Foreslå endringer, ser du en side som dette:

    Skjermbilde av skjermbildet for sammenligning av endringer.

    Pr foreslår endringer fra gaffel og gren (representert av de to elementene på høyre side av pilen) inn i dokumentasjonen repo hoved gaffel og main gren (representert av de to elementene på venstre side av pilen).

    Se gjennom endringene, og velg deretter Opprett pull-forespørsel.

  8. Forhåndsvis pr på siden Åpne en pull-forespørsel. Du kan endre tittel- eller beskrivelsesfeltene ved behov. Når du er klar, velger du Opprett pull-forespørsel. Denne handlingen åpner pr og varsler artikkeleieren om at du har foreslått en endring.

  9. Det var det! Medlemmer av innholdsteamet ser gjennom pr-forespørselen og fletter den når den godkjennes. Du kan få tilbakemelding om endringer. Hvis du vil ha mer informasjon om behandling av pr, kan du se Behandle en pull-forespørsel.

Begrensninger

  • Det mest lokaliserte (dvs. oversatte) innholdet gir ikke muligheten til å redigere gjennom GitHub. Du kan imidlertid gi tilbakemelding om oversettelseskvalitet ved å velge tilbakemeldingsknappen (tommelen) øverst på siden og deretter velge kvalitetsårsaken til oversettelsen. Du kan også gi mer spesifikk tilbakemelding om lokalisert innhold ved hjelp av skjemaet Gi tilbakemelding .
  • Redigeringsopplevelsen i nettleseren fungerer best for mindre og sjeldne endringer. Hvis du gir store bidrag eller bruker avanserte Git-funksjoner (for eksempel grenadministrasjon eller avansert konfliktløsning for fletting), anbefaler vi at du forgrener repositoriet og arbeider lokalt.