Microsoft Docs deltagarguide – översikt

Välkommen till deltagarguiden för docs.microsoft.com (Docs)!

Flera av Microsofts dokumentuppsättningar har öppen källkod och finns tillgängliga på GitHub. Vissa dokumentuppsättningar har inte öppen källkod, men många har offentliga lagringsplatser där du kan utföra rekommenderade ändringar via pull-begäranden. Användningen av öppen källkod effektiviserar och förbättrar kommunikationen mellan produkttekniker, innehållsteam, kunder och erbjuder även andra fördelar:

  • Planeringar i lagringsplatser med öppen källkod sker öppet för att ge feedback om vilka dokument som behövs mest.
  • Granskningar i lagringsplatser med öppen källkod sker öppet för att det mest användbara innehållet ska publiceras i den första utgåvan.
  • Uppdateringar i lagringsplatser med öppen källkod sker öppet för att enklare kunna förbättra innehållet kontinuerligt.

Användarupplevelsen på docs.microsoft.com integrerar GitHub-arbetsflödet direkt för att göra det ännu enklare. Börja med att redigera det dokument du visar. Eller hjälp till genom att granska nya ämnen eller skapa kvalitetsärenden.

Viktigt

Alla informationslager som publicerar till docs.microsoft.com har antagit Microsoft Open Source-uppförandekoden eller .NET Foundation-uppförandekoden. Mer information finns i vanliga frågor och svar om uppförandekoden. Eller kontakta opencode@microsoft.com, eller conduct@dotnetfoundation.org med frågor eller funderingar.

Mindre korrigeringar eller förklaringar till dokumentation och kodexempel i offentliga databaser hittar du i Användningsvillkor för docs.microsoft.com. Vid nya eller avsevärda förändringar skapas en kommentar i pull-begäran, där du ombes skicka in ett licensavtal för bidrag online om du inte är anställd inom Microsoft. Du måste fylla i hela online-formuläret innan vi kan granska eller acceptera din pull-begäran.

Snabbredigeringar i existerande dokument

Snabbredigeringar strömlinjeformar processen med att rapportera och korrigera små fel och utelämningar i dokumenten. 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 ärenden för att rapportera misstag, men det är snabbare och enklare att skapa en pull-begäran för att lösa problemet när alternativet finns 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 klickar på knappen Edit (eller motsvarande översättning) kommer du till källfilen på GitHub. Om knappen Redigera saknas innebär det att dokumentsidan inte kan ändras.

    Platsen för länken Redigera

    Om Redigera-knappen inte visas innebär det att innehållet inte är öppet för offentliga bidrag.

  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.

    Platsen för pennikonen

  3. Gör ändringar i webbredigeraren. Klicka på fliken Förhandsgranska ändringar för att kontrollera formateringen på din ändring.

  4. Då du har gjort ändringarna rullar du längst ner på sidan. Ange titel och beskrivning för dina ändringar och klicka på Föreslå filändring såsom visas i följande figur:

    Föreslå filändring

  5. Nu när du har gjort en föreslagen ändring måste du be ägaren av lagringsplatsen att ”dra” dina ändringar in i lagringsplatsen. Detta görs med någonting som kallas för ”pull-begäran”. När du väljer Föreslå filändring visas en ny sida som liknar följande:

    skapa en pull-begäran

    Välj Skapa pull-begäran, ange en rubrik och eventuellt en beskrivning för pull-begäran och välj sedan Skapa pull-begäran. Om du inte har använt GitHub, se Om pull-begäranden för mer information.

  6. Klart! Medlemmar i innehållsteamet granskar och sammanfogar din PR när den har godkänts. Du kan få feedback om att begära ändringar.

Användargränssnittet för GitHub-redigering tar hänsyn till vilka behörigheter du har för lagringsplatsen. Följande bilder är korrekta för deltagare som inte har skrivbehörigheter till mållagringsplatsen. GitHub skapar automatiskt en förgrening för mållagringsplatsen i ditt konto. Om du har skrivåtkomst till mållagringsplatsen skapar GitHub en ny gren på mållagringsplatsen. Grennamnet har formatet <GitHubId>-patch-n och använder ditt GitHub-ID och en numerisk identifierare för korrigeringsgrenen.

Vi använder pull-begäranden för alla ändringar, även för deltagare som har skrivåtkomst. De flesta lagringsplatsen har standardgrenen skyddad 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. Det finns ett undantag för Azure-dokumentationen. Det finns offentliga lokaliserade GitHub-databaser för azure-docs som är öppna för community-bidrag för 6 språk: förenklad kinesiska, franska, tyska, japanska, koreanska och spanska. För alla andra språk och innehållsuppsättningar använder du e-postmallen som tar emot dina indata på val annat språk – för att rapportera översättningsproblem eller för att ge teknisk feedback.

Granska öppna pull-begäranden

Du kan läsa nya ämnen innan de publiceras genom att kontrollera de pull-begäranden som är öppna för tillfället. 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 dokumentdatabaser och kontrollera de öppna pull-begärandena 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 dokumentsidor har avsnittet Feedback längst ner på sidan där du kan klicka för 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 hjälper dig att komma igång produktivt och bidra till Microsoft Docs. De förklarar hur du arbetar med GitHub-lagringsplatser, Markdown-verktyg och tillägg som används i Microsoft Docs-plattformen.