Dela via

Bidra till PowerShell-dokumentationen

Tack för ditt stöd för PowerShell!

Deltagarguiden är en samling artiklar som beskriver de verktyg och processer som vi använder för att skapa dokumentation på Microsoft. Några av dessa guider beskriver information som är gemensam för alla dokumentationsuppsättningar som publicerats till learn.microsoft.com. Andra guider är specifika för hur vi skriver dokumentation för PowerShell.

De vanliga artiklarna finns i vår centraliserade deltagarguide. PowerShell-specifika guider finns här.

Sätt att bidra

Det finns två sätt att bidra på. Båda bidragen är värdefulla för oss.

  • Att inlämna problem hjälper oss att identifiera problem och luckor i vår dokumentation. Ibland är problemen svåra att lösa, vilket kräver mer undersökning och forskning. Med problemprocessen kan vi prata om problemet och utveckla en tillfredsställande lösning.

  • Att skicka en pull-begäran om att lägga till eller ändra innehåll är en mer involverad process. Följande information beskriver verktyg, processer och standarder för att skicka innehåll till dokumentationen.

Förbered dig för att bidra

För att bidra till dokumentationen krävs ett GitHub-konto. Använd följande checklista för att installera och konfigurera de verktyg som du behöver för att göra bidrag.

  1. Registrera dig för GitHub
  2. Installera Git- och Markdown-verktyg
  3. Installera Docs Authoring Pack
  4. Installera Posh-Git – krävs inte men rekommenderas
  5. Konfigurera en lokal Git-lagringsplats
  6. Granska grunderna för Git och GitHub

Komma igång med att skriva dokument

Det finns två sätt att bidra med ändringar i dokumentationen:

  1. Snabbredigeringar av befintliga dokument – Mindre korrigeringar, korrigeringar av stavfel eller små tillägg
  2. Fullständigt GitHub-arbetsflöde för dokument – stora ändringar, flera versioner, tillägg eller ändring av bilder eller bidrag till nya artiklar

Läs även avsnittet Skriva väsentligheter i den centraliserade deltagarguiden. En annan utmärkt resurs är Microsofts guide för skrivstil.

Mindre korrigeringar eller förtydliganden av dokumentation och kodexempel i offentliga lagringsplatser omfattas av learn.microsoft.com användningsvillkor.

Använd det fullständiga GitHub-arbetsflödet när du gör betydande ändringar. Om du inte är anställd på Microsoft lägger vårt PR-valideringssystem till en kommentar till pull-begäran och ber dig att underteckna licensavtalet för bidrag online (CLA). Du måste slutföra det här steget innan vi kan granska eller godkänna din pull-begäran. Att signera CLA krävs bara första gången du skickar en PR i repositoryt. Du kan bli ombedd att signera CLA för varje gång du bidrar till en ny lagringsplats.

Uppförandekod

Alla lagringsplatser som publicerar till Microsoft Learn följer 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.

Nästa steg

Följande artiklar beskriver information som är specifik för PowerShell-dokumentationen. Om det finns överlappning med vägledningen i den centraliserade deltagarguiden, förklarar vi hur dessa regler skiljer sig åt för PowerShell-innehållet.

Läs följande dokument:

Ytterligare resurser

  • Last updated on