Első lépések közreműködés a PowerShell dokumentációban

Ez a cikk áttekintést nyújt a PowerShell-dokumentációban való közreműködés első lépéseiről.

PowerShell-Docs struktúra

A PowerShell-Docs-adattár két tartalomcsoportra oszlik: hivatkozásra és fogalmira.

Referenciatartalom

A referenciatartalom a PowerShellben szállított parancsmagok PowerShell-parancsmag-referenciája. A hivatkozásokat verziómappákban gyűjtjük (5.1, 7.0, 7.1 és 7.2). Ez a tartalom csak a PowerShell-lel szállított modulok parancsmag-hivatkozását tartalmazza. Ez a tartalom a parancsmag által Get-Help megjelenített súgóinformációk létrehozására is használható.

Fogalmi tartalom

A fogalmi dokumentáció a következő tartalmat tartalmazza:

  • Kibocsátási megjegyzések
  • Telepítési utasítások
  • Példaszkriptek és útmutató cikkek
  • A DSC dokumentációja
  • Az SDK dokumentációja

A fogalmi dokumentáció nem verzió szerint van rendszerezve. Minden cikk a PowerShell minden verziójához megjelenik. Dolgozunk a verzióspecifikus cikkek létrehozásán.

Megjegyzés

Minden olyan esetben, amikor egy elméleti cikket hozzáadnak, eltávolítanak vagy átneveznek, a tartalomjegyzéket frissíteni kell, és bele kell foglalni a lekéréses kérelembe.

Új cikkek létrehozása

Minden olyan új dokumentumhoz létre kell hozni egy GitHub problémát, amelyhez hozzá szeretne járulni. Ellenőrizze a meglévő problémákat, és győződjön meg arról, hogy nem duplikálja az erőfeszítéseket. A hozzárendelt problémákat a rendszer a következőnek tekinti in progress: . Ha közösen szeretne dolgozni egy problémán, lépjen kapcsolatba a problémához rendelt személlyel.

A PowerShell RFC-folyamathoz hasonlóan hozzon létre egy problémát a tartalom írása előtt. A probléma biztosítja, hogy ne pazarolja az időt és a munkát, amelyet a PowerShell-Docs csapat elutasít. A probléma lehetővé teszi, hogy konzultáljunk Önnel a tartalom hatóköréről és a PowerShell-dokumentációban való elhelyezéséről. Minden cikknek szerepelnie kell a tartalomjegyzékben. A javasolt toc helyet fel kell venni a probléma megvitatására.

Megjegyzés

A referenciatartalom tartalomjegyzékét a közzétételi rendszer automatikusan generálja. Nem kell frissítenie a toC-t.

Meglévő cikkek frissítése

Adott esetben a parancsmag-referenciacikkek duplikálva vannak az adattárban fenntartott PowerShell összes verziójában. Parancsmag-hivatkozással vagy About_ cikkel kapcsolatos probléma bejelentésekor meg kell adnia, hogy a probléma mely verziókat érinti. A GitHub hibasablonja tartalmazza a verziók ellenőrzőlistáját. A jelölőnégyzetek segítségével megadhatja, hogy a tartalom mely verzióira legyen hatással.

Ellenőrizze a cikk összes verzióját, hogy a többi verzióban is szükség van-e ugyanezre a módosításra. Alkalmazza a megfelelő módosítást a fájl minden verziójára.

Honosított tartalom

A PowerShell dokumentációja angol nyelven íródott, és 17 másik nyelvre van lefordítva. Az angol nyelvű tartalmat a rendszer a GitHub nevű adattárban MicrosoftDocs/PowerShell-Docstárolja. A honosított tartalmat a rendszer minden nyelvhez külön adattárban tárolja. Az adattárak ugyanazt az alapnevet használják, de hozzáadják a területi beállítás nevét a végéhez. Például MicrosoftDocs/PowerShell-Docs.de-de a német nyelvre lefordított tartalmat tartalmazza.

Általánosságban elmondható, hogy a problémákat és a módosításokat az angol adattárba kell elküldeni. Minden fordítás az angol tartalomból indul ki. Emberi és gépi fordítást is használunk.

Fordítási módszer Nyelvek
Emberi fordítás de-DE, es-ES, fr-FR, it-IT, ja-JP, ko-KR, pt-BR, ru-RU, zh-CN, zh-TW
Gépi fordítás cs-CZ, hu-HU, nl-NL, pl-PL, pt-PT, sv-Standard kiadás, tr-TR

Előfordulhat, hogy a gépi fordítással lefordított tartalom nem mindig eredményez megfelelő szóválasztást és nyelvhelyességet. Ha nem a cikk technikai részleteiben, hanem bármely nyelv fordításában talál hibát, nyisson meg egy problémát a honosított adattárban. Magyarázza el, miért gondolja úgy, hogy a fordítás helytelen. Honosítási csapatunk áttekinti és megválaszolja ezeket a problémákat.

Következő lépések

Az GitHub kétféle módon küldhet be módosításokat. Mindkét módszert a központi közreműködői útmutató ismerteti:

  1. A meglévő dokumentumokat gyorsan szerkesztheti a GitHub webes felületén.
  2. A teljes GitHub munkafolyamatot használhatja új cikkek hozzáadásához, több fájl frissítéséhez vagy más nagy módosításokhoz.

A módosítások megkezdése előtt létre kell hoznia egy elágazást a PowerShell-Docs-adattárból. A módosításokat a PowerShell-Docs egy munkaágában kell elvégezni. Ha a gyors szerkesztési módszert használja GitHub, a rendszer ezeket a lépéseket elvégzi. Ha a teljes GitHub munkafolyamatot használja, helyi használatra kell beállítania.

Mindkét metódus lekéréses kérelem (PR) létrehozásával ér véget. További információkért és ajánlott eljárásokért lásd: Lekéréses kérelem beküldése .