Kom igång och bidra till PowerShell-dokumentationenGet started contributing to PowerShell documentation

Den här artikeln är en översikt över hur du kommer igång med att bidra till PowerShell-dokumentationen.This article is an overview of how to get started as a contributor to the PowerShell documentation.

PowerShell-Docs strukturPowerShell-Docs structure

Databasen PowerShell-dok är uppdelad i två grupper med innehåll: referens och koncept.The PowerShell-Docs repository is divided into two groups of content: reference and conceptual.

ReferensinnehållReference content

Referens innehållet är PowerShell-cmdlet-referensen för de cmdletar som levereras i PowerShell.The reference content is the PowerShell cmdlet reference for the cmdlets that ship in PowerShell. Referensen samlas in i mapparna versioner (5,1, 7,0, 7,1 och 7,2).The reference is collected in versions folders (5.1, 7.0, 7.1, and 7.2). Det här innehållet innehåller endast cmdlet-referenser för moduler som levereras med PowerShell.This content contains cmdlet reference only for the modules that ship with PowerShell. Det här innehållet används också för att skapa hjälp informationen som visas av Get-Help cmdleten.This content is also used to create the help information displayed by the Get-Help cmdlet.

Konceptuellt innehållConceptual content

Den konceptuella dokumentationen innehåller följande innehåll:The conceptual documentation includes the following content:

  • Viktig informationRelease notes
  • Installations anvisningarSetup instructions
  • Exempel skript och instruktions artiklarSample scripts and how-to articles
  • DSC-dokumentationDSC documentation
  • SDK-dokumentationSDK documentation

Den konceptuella dokumentationen ordnas inte efter version.The conceptual documentation is not organized by version. Alla artiklar visas för alla versioner av PowerShell.All articles are displayed for every version of PowerShell. Vi arbetar för att skapa versions bara artiklar.We're working to create version-specific articles. När den här funktionen är tillgänglig i vår dokumentation kommer den här hand boken att uppdateras med lämplig information.When that feature is available in our documentation, this guide will be update with the appropriate information.

Anteckning

När en konceptuell artikel läggs till, tas bort eller ändras, måste innehålls förteckningen uppdateras och tas med i pull-begäran.Anytime a conceptual article is added, removed, or renamed, the TOC must be updated and included in the pull request.

Skapa nya artiklarCreating new articles

Ett GitHub-problem måste skapas för alla nya dokument som du vill bidra.A GitHub issue must be created for any new document you want to contribute. Sök efter befintliga problem för att se till att du inte duplicerar aktiviteter.Check for existing issues to make sure you're not duplicating efforts. Tilldelade problem anses vara in progress .Assigned issues are considered to be in progress. Om du vill samar beta om ett problem kontaktar du personen som har tilldelats problemet.If you wish to collaborate on an issue, contact the person assigned to the issue.

Precis som i PowerShell RFC-processenskapar du ett problem innan du skriver innehållet.Similar to the PowerShell RFC process, create an issue before you write the content. Problemet garanterar att du inte slösar tid och arbetar på arbete som avvisas av PowerShell-Docss teamet.The issue ensures you don't waste time and effort on work that gets rejected by the PowerShell-Docs team. Problemet gör att vi kan kontakta dig med innehålls området och var det passar i PowerShell-dokumentationen.The issue allows us to consult with you on the scope of the content and where it fits in the PowerShell documentation. Alla artiklar måste inkluderas i innehålls förteckningen (TOC).All articles must be included in the Table of Contents (TOC). Den föreslagna TOC-platsen ska ingå i ärende diskussionen.The proposed TOC location should be included in the issue discussion.

Anteckning

Innehålls förteckningen för referens innehållet genereras automatiskt av publicerings systemet.The TOC for reference content is autogenerated by the publishing system. Du behöver inte uppdatera innehålls förteckningen.You don't have to update the TOC.

Befintliga artiklar uppdaterasUpdating existing articles

I tillämpliga fall dupliceras cmdlet Reference-artiklar i alla versioner av PowerShell i den här lagrings platsen.Where applicable, cmdlet reference articles are duplicated across all versions of PowerShell maintained in this repository. När du rapporterar ett problem med en cmdlet-referens eller en About_ artikel, måste du ange vilka versioner som påverkas av problemet.When reporting an issue about a cmdlet reference or an About_ article, you must specify which versions are affected by the issue. Issue-mallen i GitHub innehåller en check lista för versioner.The issue template in GitHub includes a checklist of versions. Använd kryss rutorna för att ange vilka versioner av innehållet som påverkas.Use the checkboxes to specify which versions of the content are affected.

Kontrol lera alla versioner av artikeln för att se om samma ändring krävs i de andra versionerna.Check all version of the article to see if the same change is needed in the other versions. Tillämpa lämplig ändring för varje version av filen.Apply the appropriate change to each version of the file.

Lokaliserat innehållLocalized content

PowerShell-dokumentationen skrivs på engelska och översätts till 17 andra språk.The PowerShell documentation is written in English and translated into 17 other languages. Det engelska innehållet lagras i GitHub-lagringsplatsen med namnet MicrosoftDocs/PowerShell-Docs .The English content is stored in the GitHub repository named MicrosoftDocs/PowerShell-Docs. Det lokaliserade innehållet lagras i en separat lagrings plats för varje språk.The localized content is stored in a separate repository for each language. Databaserna använder samma basename men lägger till språk namnet i slutet.The repositories use the same basename but add the locale name to the end. Innehåller till exempel MicrosoftDocs/PowerShell-Docs.de-de det innehåll som har översatts till tyska.For example, MicrosoftDocs/PowerShell-Docs.de-de contains the content that was translated to German.

I allmänhet bör problem och ändringar skickas till den engelska lagrings platsen.In general, issues and changes should be submitted to the English repository. Alla översättningar börjar från det engelska innehållet först.All translations start from the English content first. Vi använder både mänsklig och maskin översättning.We use both human and machine translation.

Översättnings metodTranslation method SpråkLanguages
Mänsklig översättningHuman translation de-DE, es-ES, fr-FR, IT-IT, ja-JP, ko-KR, pt-BR, ru-RU, zh-CN, zh-TWde-DE, es-ES, fr-FR, it-IT, ja-JP, ko-KR, pt-BR, ru-RU, zh-CN, zh-TW
Maskin ÖversättningMachine translation CS-CZ, hu-HU, nl-NL, pl-PL, pt-PT, sa-SE, tr-TRcs-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 leder till rätt Word-val och grammatik.The content translated by machine translation may not always result in correct word choices and grammar. 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 i den lokaliserade lagrings platsen.If you find an error in translation for any language, rather than in the technical details of the article, open an issue in the localized repository. Förklara varför du tycker att översättningen är felaktig.Explain why you think the translation is incorrect. Vårt lokaliserings team granskar och åtgärdar problemen.Our localization team reviews and responds to these issues.

Nästa stegNext steps

Det finns två vanliga sätt att skicka ändringar i GitHub.There are two common ways of submitting changes in GitHub. Båda metoderna beskrivs i Central bidrags guide:Both methods are described in the central Contributor's Guide:

  1. Du kan göra snabba ändringar i befintliga dokument i GitHub-webbgränssnittet.You can make quick edits to existing documents in the GitHub web interface.
  2. Använd det fullständiga GitHub-arbetsflödet för att lägga till nya artiklar, uppdatera flera filer eller andra stora ändringar.Use the full GitHub workflow for adding new articles, updating multiple files, or other large changes.

Innan du påbörjar ändringarna bör du skapa en förgrening av PowerShell-Docs-lagringsplatsen.Before starting any changes, you should create a fork of the PowerShell-Docs repository. Ändringarna bör göras i en arbets gren i din kopia av PowerShell-dokumenten. Om du använder Quick Edit -metoden i GitHub hanteras dessa steg åt dig.The changes should be made in a working branch in you copy of the PowerShell-Docs. If you're using the quick edit method in GitHub, these steps are handled for you. Om du använder det fullständiga GitHub-arbetsflödet måste du konfigureras att fungera lokalt.If you're using the full GitHub workflow, you must be set up to work locally.

Båda metoderna slutar med att skapa en pull-begäran (PR).Both methods end with the creation of a Pull Request (PR). Mer information och bästa praxis finns i skicka en pull-begäran .See Submitting a pull request for more information and best practices.