Microsoft Docs deltagarguide – översikt

Välkommen till deltagarguiden för Microsoft Docs!

Genom att dela dina kunskaper med andra på Microsoft Learn kan alla uppnå mer. Använd informationen i den här guiden för att publicera en ny artikel i Microsoft Learn eller göra uppdateringar av en befintlig publicerad artikel.

Genom att dela dina kunskaper med andra på Learn kan alla uppnå mer. Använd informationen i den här guiden för att publicera en ny artikel för att learn.microsoft.com eller göra uppdateringar av en artikel som redan har publicerats.

Flera av Microsofts dokumentuppsättningar har öppen källkod och finns tillgängliga på GitHub. Alla dokumentuppsättningar är inte helt öppen källkod, men många har offentliga lagringsplatser där du kan föreslå ändringar via pull-begäranden (PR). Den här metoden med öppen källkod effektiviserar och förbättrar kommunikationen mellan produkttekniker, innehållsteam och kunder, och den har andra fördelar:

  • Plan för lagringsplatser med öppen källkod i det öppna för att få feedback om vilka dokument som behövs mest.
  • Granskning av lagringsplatser med öppen källkod i öppningen för att publicera det mest användbara innehållet i vår första version.
  • Uppdatering av lagringsplatser med öppen källkod i det öppna för att göra det enklare att kontinuerligt förbättra innehållet.

Användarupplevelsen på Microsoft Learn integrerar GitHub-arbetsflöden direkt för att göra det ännu enklare. Börja med att redigera dokumentet som du visar. Eller hjälp med att granska nya ämnen eller skapa kvalitetsproblem.

Viktigt

Alla lagringsplatser som publicerar till Microsoft Learn har antagit Microsofts uppförandekod för öppen källkod eller .NET Foundations uppförandekod. Mer information finns i vanliga frågor och svar om uppförandekoden. Kontakta opencode@microsoft.com eller conduct@dotnetfoundation.org med frågor eller kommentarer.

Mindre korrigeringar eller förtydliganden av dokumentation och kodexempel på offentliga lagringsplatser omfattas av learn.microsoft.com användningsvillkor. Nya eller betydande ändringar genererar en kommentar i pull-begäran och ber dig att skicka in ett licensavtal för bidrag online om du inte är anställd på Microsoft. Du måste fylla i onlineformuläret innan vi kan granska eller godkänna din pull-begäran.

Snabbredigeringar i dokumentationen

Snabbredigeringar effektiviserar processen för att rapportera och åtgärda små fel och utelämnanden i dokumentationen. Trots stora ansträngningar händer det att en del mindre grammatiska fel och stavfel smyger sig in i våra publicerade dokument. Du kan skapa problem för att rapportera misstag, men det är snabbare och enklare att skapa en pull-begäran för att åtgärda problemet när alternativet är tillgängligt.

  1. Vissa dokumentsidor låter dig redigera innehåll direkt i webbläsaren. Du ser i sådana fall knappen Edit (Redigera) som på bilden nedan. Om du väljer knappen Redigera (eller motsvarande lokaliserad) kommer du till källfilen på GitHub.

    Plats för redigeringsartikellänken.

    Om knappen Redigera inte finns innebär det att innehållet inte är öppet för offentliga bidrag. Vissa sidor genereras (till exempel från infogad dokumentation i kod) och måste redigeras i det projekt som de tillhör.

  2. Välj pennikonen för att redigera artikeln. Om pennikonen är nedtonad måste du antingen logga in på ditt GitHub-konto eller skapa ett nytt konto.

    Förgrenings- och redigeringspennaikonens plats.

  3. Redigera filen i webbredigeraren. Välj fliken Förhandsgranska för att kontrollera formateringen av dina ändringar.

  4. När du är klar med redigeringen bläddrar du längst ned på sidan. I området Föreslå ändringar anger du en rubrik och eventuellt en beskrivning av dina ändringar. Rubriken blir den första raden i incheckningsmeddelandet. Välj Föreslå ändringar för att checka in ändringarna:

    Föreslå och checka in filändringar.

  5. Nu när du har föreslagit och checkat in ändringarna måste du be lagringsplatsens ägare att "hämta" ändringarna till deras lagringsplats. Detta görs med något som kallas "pull-begäran" (PR). När du väljer Föreslå ändringar visas en ny sida som liknar följande:

    Jämför ändringar och skapa pull-begäran.

    Välj Skapa pull-begäran. Ange sedan en rubrik och en beskrivning för pull-begäran och välj sedan Skapa pull-begäran. Mer information finns i Om pull-begäranden om du inte har använt GitHub tidigare.

  6. Klart! Medlemmar i innehållsteamet granskar din pull-begäran och sammanfogar den när den godkänns. Du kan få feedback som begär ändringar.

Användargränssnittet för GitHub-redigering tar hänsyn till vilka behörigheter du har för lagringsplatsen. Föregående bilder är avsedda för deltagare som inte har skrivbehörighet till mållagringsplatsen. GitHub skapar automatiskt en förgrening för mållagringsplatsen i ditt konto. Det nyligen skapade förgreningsnamnet har formuläret GitHubUsername/RepositoryName som standard. Om du har skrivåtkomst till mållagringsplatsen, till exempel din förgrening, skapar GitHub en ny gren på mållagringsplatsen. Grennamnet har standardformuläret patch-n, med hjälp av en numerisk identifierare för korrigeringsgrenen.

Vi använder pull-begäran för alla ändringar, även för deltagare som har skrivåtkomst. De flesta lagringsplatser skyddar standardgrenen så att uppdateringar måste skickas som pull-begäranden.

Redigeringsupplevelsen i webbläsaren är bäst för mindre eller inte ofta förekommande ändringar. Om du gör stora bidrag eller använder avancerade Git-funktioner (till exempel förgreningshantering eller avancerad kopplingskonfliktlösning) behöver du förgrena lagringsplatsen och arbeta lokalt.

Anteckning

De flesta lokaliserade dokumentationen ger inte möjlighet att redigera eller ge feedback via GitHub. Om du vill ge feedback om lokaliserat innehåll använder du e-postmallen som finns på aka.ms/DocSiteLocFeedback.

Granska öppna pull-begäranden

Du kan läsa nya ämnen innan de publiceras genom att kontrollera den öppna PR-kön. Granska följande process för GitHub-flöde. Du kan se föreslagna uppdateringar eller nya artiklar i de offentliga lagringsplatserna. Granska dem och lägg till dina kommentarer. Titta på någon av våra Microsoft Learn-lagringsplatser och kontrollera de öppna PR:erna för områden som intresserar dig. Community-feedback för föreslagna uppdateringar hjälper hela communityn.

Skapa kvalitetsärenden

Våra dokument är under ständigt pågående arbete. Bra ärenden hjälper oss att fokusera våra ansträngningar med högsta prioritet för communityn. Ju fler detaljer du kan lämna, desto bättre. Berätta för oss vilken information du sökte efter. Berätta vilka söktermer du använde. Om du inte kan komma igång, berätta för oss hur du vill börja utforska okänd teknik.

Många av Microsofts dokumentationssidor har ett feedbackavsnitt längst ned på sidan där du kan välja att lämna produktfeedback eller innehållsfeedback för att spåra problem som är specifika för den artikeln.

Ärenden påbörjar konversationen om vad som behövs. Innehållsteamet kommer att svara på dessa ärenden med idéer om vad vi kan lägga till och be om dina åsikter. Vi kan skapa en skiss och vi kommer att be dig att granska pull-begärandet.

Bli mer involverad

Andra ämnen i den här guiden hjälper dig att komma igång produktivt med att bidra till Microsoft Learn. De förklarar hur du arbetar med GitHub-lagringsplatser, Markdown-verktyg och tillägg som används i Microsoft Learn-innehållet.