Kom igång med att bidra till PowerShell-dokumentationen

Den här artikeln är en översikt över hur du kommer igång som deltagare i PowerShell-dokumentationen.

PowerShell-Docs struktur

Det finns tre innehållskategorier på PowerShell-Docs- lagringsplats:

• referensinnehåll
• konceptuellt innehåll
• metadata och konfigurationsfiler

Referensinnehåll

Referensinnehållet är PowerShell-cmdlet-referensen för de cmdletar som levereras i PowerShell. Cmdlet-referensen samlas in i versionsmappar (till exempel 5.1, 7.4, 7.5 och 7.6), som innehåller referensen för de moduler som levereras med PowerShell. Det här innehållet används också för att skapa hjälpinformationen som visas av cmdleten Get-Help.

Konceptuellt innehåll

Den konceptuella dokumentationen är inte ordnad efter version. Alla artiklar visas för varje version av PowerShell.

Notera

När en konceptuell artikel läggs till, tas bort eller byts namn måste toc uppdateras. Alla borttagna eller omdöpta filer måste omdirigeras.

Metadatafiler

Det här projektet innehåller flera typer av metadatafiler. Metadatafilerna styr beteendet för våra byggverktyg och publiceringssystemet. Endast PowerShell-Docs underhållare och godkända bidragsgivare får ändra dessa filer. Om du anser att en metafil bör ändras öppnar du ett problem för att diskutera de ändringar som behövs.

Metafiler i lagringsplatsens rot

• .* – konfigurationsfiler i lagringsplatsens rot
• *.md – Projektdokumentation i lagringsplatsens rot
• *.yml – Projektdokumentation i lagringsplatsens rot
• .devcontainer/* – devcontainer-konfigurationsfiler
• .github/**/* – GitHub-mallar, åtgärder och andra metafiler
• .vscode/**/* – Konfigurationer av VS Code-tillägg
• assets/* – innehåller nedladdningsbara filer som är länkade i dokumentationen
• redir/* – innehåller mappningsfiler för omdirigering
• tests/* – testverktyg som används av byggsystemet
• tools/* – andra verktyg som används av byggsystemet

Metafiler i dokumentationsuppsättningen

• reference/**/*.json – konfigurationsfiler för dokumentuppsättningar
• reference/**/*.yml – Innehållsförteckning och andra strukturerade innehållsfiler
• reference/bread/* – brödsmulnavigeringskonfiguration
• reference/includes/* – markdown inkluderar filer
• reference/mapping/* – konfiguration av versionshantering
• reference/**/media/** – bildfiler som används i dokumentationen
• reference/module/* – Konfiguration av sidan Module Browser

Skapa nya artiklar

Ett GitHub-ärende måste skapas för varje nytt dokument som du vill bidra med. Kontrollera om det finns befintliga problem för att se till att du inte duplicerar arbetet. Tilldelade problem anses vara in progress. Om du vill samarbeta om ett problem kontaktar du den person som tilldelats problemet.

På samma sätt som i PowerShell RFC-processskapar du ett problem innan du skriver innehållet. Lösningen säkerställer att du inte slösar tid och ansträngning på arbete som avvisas av PowerShell-Docs-teamet. Problemet gör att vi kan kontakta dig om innehållets omfattning och var det passar i PowerShell-dokumentationen. Alla artiklar måste ingå i innehållsförteckningen (TOC). Den föreslagna TOC-platsen bör ingå i diskussionen kring problemet.

Notera

Publiceringssystemet skapar automatiskt innehållsförteckningen för referensinnehåll. Du behöver inte uppdatera toc-koden.

Uppdatera befintliga artiklar

I tillämpliga fall dupliceras cmdlet-referensartiklar i alla versioner av PowerShell som underhålls på den här lagringsplatsen. När du rapporterar ett problem om en cmdlet-referens eller en About_ artikel listar du de versioner av artikeln som har problemet.

Tillämpa lämplig ändring på varje version av filen.

Lokaliserat innehåll

PowerShell-dokumentationen är skriven på engelska och översatt till 17 andra språk. Det engelska innehållet lagras på GitHub-lagringsplatsen med namnet MicrosoftDocs/PowerShell-Docs. Problem som hittas i det översatta innehållet bör skickas till den här lagringsplatsen.

Alla översättningar börjar från det engelska innehållet först. Vi använder både mänsklig översättning och maskinöversättning.

Översättningsmetod	Språk
Mänsklig översättning	de-DE, es-ES, fr-FR, it-IT, ja-JP, ko-KR, pt-BR, ru-RU, zh-CN, zh-TW
Maskinöversättning	cs-CZ, hu-HU, nl-NL, pl-PL, pt-PT, sv-SE, tr-TR

Innehållet som översätts av maskinöversättning kanske inte alltid resulterar i rätt ordval och grammatik. Om du hittar ett fel i översättningen för något språk, i stället för i den tekniska informationen i artikeln, öppnar du ett problem som förklarar varför du tror att översättningen är fel.

Vissa översättningsproblem kan åtgärdas genom att ändra de engelska källfilerna. Vissa problem kan dock kräva uppdateringar av vårt interna översättningssystem. I dessa fall måste vi skicka problemet till vårt interna lokaliseringsteam för granskning och svar.

Nästa steg

Det finns två vanliga sätt att skicka ändringar på GitHub. Båda metoderna beskrivs i den centrala deltagarguiden:

1. Du kan göra snabba redigeringar av befintliga dokument i GitHub-webbgränssnittet.
2. Använd det fullständiga GitHub-arbetsflödet för att lägga till nya artiklar, uppdatera flera filer eller andra stora ändringar.

Innan du påbörjar några ändringar bör du skapa en fork av PowerShell-Docs-förvaret. Ändringarna bör göras i en arbetsgren i din kopia av PowerShell-Docs. Om du använder snabbredigeringsmetoden i GitHub hanteras de här stegen åt dig. Om du använder det fullständiga GitHub-arbetsflödetmåste du konfigureras för att arbeta lokalt.

Båda metoderna slutar med att en Pull Request (PR) skapas. Mer information och metodtips finns i Skicka en pull-begäran.