Oversikt over veiledningen for bidragsytere til Microsoft Docs

Velkommen til veiledningen for bidragsytere til docs.microsoft.com!

Flere av dokumentasjonssettene fra Microsoft er åpen kilde og driftes av GitHub. Enkelte dokumentasjonssett er ikke fullstendig åpen kilde, men mange har repositorier som er åpne for publikum, der du kan foreslå endringer via pull-forespørsler. Denne fremgangsmåten for åpen kilde effektiviserer og forbedrer kommunikasjonen mellom produktteknikere, innholdsmedarbeidere og kunder, og har dessuten andre fordeler:

  • Offentlig planlegging av repositorier for åpen kilde for å få tilbakemeldinger om hvilken dokumentasjon som trengs mest.
  • Offentlig gjennomgang av repositorier for åpen kilde for å publisere det nyttigste innholdet i første utgivelse.
  • Offentlig oppdatering av repositorier for åpen kilde for å gjøre det enklere å fortsette å forbedre innholdet.

Brukeropplevelsen på docs.microsoft.com integrerer arbeidsflyter fra GitHub direkte for å gjøre det enda enklere. Start ved å redigere dokumentet du viser. Du kan også hjelpe ved å revidere nye emner eller opprette kvalitetssaker.

Viktig!

Alle repositorier som publiserer på docs.microsoft.com, har tatt i bruk Microsofts regler for god opptreden for åpne kilder eller .NET Foundations regler for god opptreden. 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 klargjøring av dokumentasjon og kodeeksempler i offentlige repositorier dekkes i Vilkår for bruk av docs.microsoft.com. Nye eller vesentlige endringer genererer en kommentar i pull-forespørselen og ber deg om å sende en nettbasert bidragslisensavtale hvis du ikke er medarbeider hos Microsoft. Du må fylle ut nettskjemaet før vi kan gå gjennom eller godta pull-forespørselen din.

Rask redigering av eksisterende dokumenter

Rask redigering gjør det enklere å rapportere og fikse små feil og utelatelser i dokumentene. Til tross for at vi arbeider hardt for å unngå det,sniker det seg inn små grammatiske feil og stavefeil i dokumentene vi publiserer. Du kan opprette en sak for å rapporterer en feil, men det er kjappere og enklere å opprette en pull-forespørsel for å rette den opp, når dette er tilgjengelig.

  1. Noen dokumentsider tillater deg å redigere innhold direkte i nettleseren. I så fall ser du en Rediger-knapp som den som vises nedenfor. Hvis du klikker på redigerings-knappen, kommer du til kildefilen på GitHub. Hvis Rediger-knappen mangler, betyr det at dokumentasjonssiden ikke kan endres.

    Plassering av redigeringskoblingen

    Hvis Rediger-knappen ikke vises, betyr det at innholdet ikke er åpent for offentlige bidrag.

  2. Velg blyantikonet for å redigere artikkelen. Hvis blyant-ikonet er grått, må du enten logge deg på en GitHub-konto, eller opprette en ny konto.

    Plassering av blyantikonet

  3. Gjør endringer i redigeringsprogrammet på nettet. Hvis du vil sjekke formateringen av endringen du har gjort, kan du klikke på Forhåndsvis endringer.

  4. Rull til bunnen av siden når du er ferdig med redigeringen. Skriv inn en tittel og beskrivelse av endringen, og klikk på Foreslå filendring, som vist i den neste illustrasjonen:

    Foreslå filendring

  5. Nå som du har foreslått endringen, må du spørre eierne av repositoriet om å «hente» endringene til repositoriet deres. Dette gjøres ved hjelp av noe som kalles en «pull-forespørsel». Når du velger Foreslå filendring, vises en ny side som ligner på følgende:

    opprett pull-forespørsel

    Velg Opprett pull-forespørsel, skriv inn en tittel og eventuelt en beskrivelse av pull-forespørselen, og velg deretter Opprett pull-forespørsel. Hvis gitHub er nytt for deg, kan du se Om pull-forespørsler for mer informasjon.

  6. Det var det! Medlemmer fra innholdsteamet ser gjennom og slår sammen pr-en din når den er godkjent. Du kan få tilbakemelding med forespørsler om endringer.

Brukergrensesnittet for redigering på GitHub reagerer på tillatelsene du har på repositoriet. De viste bildene viser hvordan det ser ut for brukere som ikke har skrivetillatelse for målrepositoriet. GitHub oppretter automatisk en forgrening av målrepositoriet i kontoen din. Hvis du har skrivetilgang for målrepositoriet, opprettes det en ny gren i målrepositoriet i GitHub. Grenen får et navn som følger mønsteret <GitHubId>-oppdatering-n, og bruker GitHub-ID-en din og et nummer som identifiserer oppdateringsgrenen.

Vi bruker pull-forespørsler til alle endringer, til og med for bidragsytere med skrivetillatelse. De fleste repositorier har standardgrenen beskyttet, og oppdateringer må gjøres som pull-forespørsler.

Redigering i nettleser er best for små endringer og for endringer som ikke skjer ofte. Hvis du leverer store bidrag eller bruker avanserte Git-funksjoner (for eksempel grenadministrering eller løsing av avanserte sammenslåingskonflikter), må du opprette en forgrening av repositoriet og arbeide lokalt.

Obs!

Mest lokalisert dokumentasjon gir ikke muligheten til å redigere eller gi tilbakemelding gjennom GitHub. Hvis du vil gi tilbakemelding på lokalisert innhold, kan du bruke e-postmalen som er tilgjengelig på aka.ms/DocSiteLocFeedback. Det finnes ett unntak for Azure-dokumentasjonen. Det finnes offentlige lokaliserte GitHub-repositorier for Azure-dokumenter som er åpne for bidrag fra fellesskapet på seks språk: Forenklet kinesisk, fransk, tysk, japansk, koreansk og spansk. Bruk e-postmalen for alle andre språk og innholdssett, som mottar inndata på et hvilket som helst språk, til å rapportere oversettelsesproblemer eller gi teknisk tilbakemelding.

Gå gjennom åpne pull-forespørsler

Hvis du sjekker åpne pull-forespørsler, kan du lese nye emner før de blir publisert. Gjennomganger følger prosessen for GitHub-flyt. Du kan se forslåtte oppdateringer og nye artikler i offentlige repositorier. Gå gjennom dem, og legg til dine kommentarer. Hvis du vil finne noe du er interessert i, kan du se gjennom dokumentrepositoriene våre og sjekke de åpne pull-forespørslene. Tilbakemeldinger fra fellesskapet om foreslåtte oppdateringer hjelper hele fellesskapet.

Opprett kvalitetssaker

Vi jobber alltid på dokumentasjonen vår. Hvis sakene har høy kvalitet, kan vi fokusere på sakene med høyest prioritet i felleskapet. Jo flere detaljer du har, jo nyttigere er saken. Fortell oss hva du så etter. Fortell oss hvilke ord du søkte etter. Hvis du ikke kan komme i gang, kan du fortelle oss hvordan du vil begynne å utforske ny teknologi.

Mange av dokumentasjonssidene fra Microsoft har en Tilbakemelding-inndeling nederst på siden hvor du kan klikke for å legge igjen tilbakemelding om produktet eller tilbakemelding om innholdet for å spore problemer som er særegne for den artikkelen.

Saker starter samtalen om hva som må gjøres. Innholdsgruppen svarer på sakene med ideer om hva vi kan legge til, og spør hva du syns. Når vi har opprettet et utkast, vil vi be deg om å gå gjennom pull-forespørselen.

Gjør mer

Andre emner viser deg hvordan du kommer i gang med å bidra til Microsoft Docs på en produktiv måte. De forklarer hvordan du arbeider med GitHub-repositorier, Markdown-verktøy og tillegg som brukes på Microsoft Docs-plattformen.