Ismerkedés a PowerShell-dokumentációvalGet started contributing to PowerShell documentation

Ez a cikk áttekinti, hogyan kezdheti el közreműködőként a PowerShell-dokumentációt.This article is an overview of how to get started as a contributor to the PowerShell documentation.

PowerShell – docs-struktúraPowerShell-Docs structure

A PowerShell-docs tárház két csoportra oszlik.The PowerShell-Docs repository is divided into two groups of content. A git-ágak segítségével kezelheti a dokumentáció közzétételének módját és idejét.Git branches are used to manage how and when documentation gets published.

Hivatkozási tartalomReference content

A hivatkozási tartalom a PowerShell-parancsmagok PowerShell-parancsmagokra mutató hivatkozása.The reference content is the PowerShell cmdlet reference for the cmdlets that ship in PowerShell. A rendszer a hivatkozásokat a verziók mappáiba gyűjti (5,1, 6, 7,0 és 7,1).The reference is collected in versions folders (5.1, 6, 7.0, and 7.1). Ez a tartalom csak a PowerShell-lel rendelkező modulok parancsmag-hivatkozását tartalmazza.This content contains cmdlet reference only for the modules that ship with PowerShell. Ez a tartalom a parancsmag által megjelenített Súgó információinak létrehozására is használható Get-Help .This content is also used to create the help information displayed by the Get-Help cmdlet.

Megjegyzés

A hivatkozási tartalom tartalomjegyzékét a közzétételi rendszer automatikusan létrehozza.The Table of Contents (TOC) for reference content is autogenerated by the publishing system. Nem kell frissítenie a TARTALOMJEGYZÉKet.You don't have to update the TOC.

Elméleti tartalomConceptual content

A koncepcionális dokumentáció a következő tartalmakat tartalmazza:The conceptual documentation includes the following content:

  • Kibocsátási megjegyzésekRelease notes
  • Telepítési utasításokSetup instructions
  • Példák a parancsfájlokra és útmutató cikkekreSample scripts and how-to articles
  • DSC-dokumentációDSC documentation
  • Az SDK dokumentációjaSDK documentation

A fogalmi dokumentációt nem a verzió szerint rendezi a rendszer.The conceptual documentation is not organized by version. Minden cikk megjelenik a PowerShell minden verziójában.All articles are displayed for every version of PowerShell. Dolgozunk a verzió-specifikus cikkek létrehozásán.We are working to create version-specific articles. Ha ez a funkció elérhető a dokumentációban, ez az útmutató a megfelelő információkkal fog frissülni.When that feature is available in our documentation, this guide will be update with the appropriate information.

Megjegyzés

A TARTALOMJEGYZÉKet bármikor fel kell venni, törölni vagy átnevezni kell, és a lekéréses kérelemben szerepelnie kell.Anytime a conceptual article is added, removed, or renamed, the TOC must be updated and included in the pull request.

Git-ágak használataUsing git branches

A PowerShell-docs alapértelmezett ága az staging ág.The default branch for PowerShell-Docs is the staging branch. A munkaágakban végrehajtott módosítások a közzététel előtt egyesülnek az staging ágra.Changes made in working branches are merged into the staging branch before then being published. Körülbelül hetente egyszer az staging ág egyesítve lesz a live fiókirodában.About once a week, the staging branch is merged into the live branch. Az live ág tartalmazza a docs.microsoft.com közzétett tartalmat.The live branch contains the content that is published to docs.microsoft.com. A módosításokat soha nem kell közvetlenül a ágban beírni live .Changes should never be made directly in the live branch.

Amikor olyan dokumentációmódosítást küld, amely csupán a PowerShell egy még nem kiadott verziójára vonatkozik, ellenőrizze, hogy van-e kiadási ág az adott verzióhoz.If you are submitting a change to documentation that only applies to an unreleased version of PowerShell, check to see if there is a release branch for that version. Az adott, jövőbeli verzióra vonatkozó összes módosítás céljaként a kiadási ágat kell megadni.All changes that apply to a specific, future version should be targeted at the release branch. A kiadási ágak a következő elnevezési sémával rendelkeznek: release-<version>.Release branches have the following name pattern: release-<version>.

A módosítások megkezdése előtt hozzon létre egy munkaágat a PowerShell-docs adattár helyi példányában.Before starting any changes, create a working branch in your local copy of the PowerShell-Docs repository. Ennek az elágazásának klónjánakkell lennie.This should be a clone of your fork. A munkaág létrehozása előtt ne felejtse el szinkronizálni a helyi tárházat.Be sure to synchronize your local repository before creating your working branch. A munkaágat a vagy az ág frissítésről-másolási másolatából kell létrehozni staging release .The working branch should be created from an update-to-date copy of the staging or release branch.

Végezze el a módosításokat, amelyeket a központi közreműködő útmutatójának a changeing (módosítás ) szakaszában a folyamat után kell elküldenie.Make the changes you want to submit following the process in the Making your change section of the central Contributor's Guide.

Új cikkek létrehozásaCreating new articles

Létre kell hozni egy GitHub-problémát minden olyan új dokumentumhoz, amelyet hozzá szeretne járulni.A GitHub issue must be created for any new document you want to contribute. Ellenőrizze, hogy vannak-e meglévő problémák, és győződjön meg arról, hogy nem duplikálja az erőfeszítéseket.Check for existing issues to make sure you're not duplicating efforts. A valakihöz rendelt problémák "folyamatban" állapotnak tekintendők.Issues that are assigned to someone are considered to be "in progress". Ha a probléma megoldásához szeretne együttműködni, forduljon a problémaért felelős személyhez.If you wish to collaborate on an issue, contact the person assigned to the issue.

A PowerShell RFC- folyamathozhasonlóan a tartalom megírása előtt a probléma megoldásával gondoskodhat arról, hogy ne töltsön túl sok időt és erőfeszítést a PowerShell-docs csapat által elutasított műveletre.Similar to the PowerShell RFC process, creating an issue before writing the content ensures that you don't spend a lot of time and effort on something that gets rejected by the PowerShell-Docs team. Ez azt is lehetővé teszi, hogy konzultáljon Önnel a tartalom hatókörén, és hogy a PowerShell-dokumentáción belül hol is illeszkedjen.This also allows us to consult with you on the scope of the content and where it should fit within the PowerShell documentation.

Meglévő cikkek frissítéseUpdating existing articles

Ha alkalmazható, a parancsmag-hivatkozási cikk a PowerShell összes verziójában duplikálva van.Where applicable, cmdlet reference article are duplicated across all versions of PowerShell. Ha egy parancsmag-referenciával vagy egy cikkel kapcsolatos problémát jelent About_ , meg kell adnia, hogy mely verziókat érinti a probléma.When reporting an issue about a cmdlet reference or an About_ article, you must specify which versions are affected by the issue. A GitHubon található probléma sablon tartalmazza a verziók listáját.The issue template in GitHub includes a checklist of versions. A jelölőnégyzetek segítségével megadhatja, hogy a tartalom mely verzióit érinti.Use the checkboxes to specify which versions of the content are affected. Ha olyan probléma esetén küld el egy cikket, amely a tartalom több verzióját érinti, akkor a fájl minden egyes verziójára alkalmaznia kell a megfelelő módosítást.When you submit a change to a article for an issue that affects multiple versions of the content, you must apply the appropriate change to each version of the file.

Következő lépésekNext steps

Lásd: lekéréses kérelem elküldéseSee Submitting a pull request