Közreműködés a PowerShell dokumentációjában

  • Cikk

Köszönjük a PowerShell támogatását!

A Közreműködői útmutató olyan cikkek gyűjteménye, amelyek a Microsoft dokumentációjának létrehozásához használt eszközöket és folyamatokat írják le. Ezen útmutatók némelyike a -hez közzétett dokumentációk közös információit docs.microsoft.com tartalmazza. Az útmutatók némelyike kifejezetten a PowerShell dokumentációjának írására vonatkozik.

A gyakori cikkek a központi közreműködői útmutatóban érhetők el. A PowerShell-specifikus útmutatók itt érhetők el.

Közreműködési lehetőségek

A közreműködésnek két módja van. Mindkét hozzájárulás értékes számunkra.

  • A problémák bejelentése segít azonosítani a problémákat és a hiányosságokat a dokumentációban. Néha nehéz megoldani a problémákat, ami több vizsgálatot és kutatást igényel. A problémafolyamat lehetővé teszi, hogy beszélgetést folytatunk a problémával kapcsolatban, és kielégítő megoldást alakítsunk ki.

  • A tartalom hozzáadására vagy változására vonatkozó lekéréses kérelem elküldése inkább egy folyamat. Az alábbi információk ismertetik a tartalom dokumentációba való beküldéséhez szükséges eszközöket, folyamatokat és szabványokat.

Felkészülés a közreműködésre

A közreműködéshez GitHub-fiókra van szükség. A következő ellenőrzőlista segítségével telepítheti és konfigurálhatja a közreműködéshez szükséges eszközöket.

  1. GitHub-regisztráció
  2. Git- és Markdown-eszközök telepítése
  3. A Docs Authoring Pack telepítése
  4. A Posh-Git telepítése – nem kötelező, de ajánlott
  5. Helyi Git-tárház beállítása
  6. A Git és a GitHub áttekintése

A dokumentumok írásának első lépései

Kétféleképpen járulhat hozzá a dokumentáció módosításaihoz:

  1. Meglévő dokumentumok gyors szerkesztése
    • Kisebb javítások, el hibák javítása vagy kis kiegészítések
  2. Teljes GitHub munkafolyamat dokumentumokhoz
    • nagy változások, több verzió, képek hozzáadása vagy módosítása, vagy új cikkekhez való hozzájárulás

Olvassa el a központi közreműködői útmutató Writing essentials (Írási alap) című szakaszát is. Egy másik kiváló forrás a Microsoft írásstílusra vonatkozó útmutatója. A Microsoft írásstílusra vonatkozó útmutatója célja, hogy segítse a szerkesztőket, a műszaki írókat, a fejlesztőket, a marketingeseket és az it-fejlesztőket abban, hogy jobb tartalmakat írjanak.

A nyilvános adattárakban található dokumentációk és kódpélyák kisebb javításait vagy pontosítását a docs.microsoft.com használati feltételei fedezik.

Ha jelentős módosításokat GitHub, használja a teljes munkafolyamatot. Ha Ön nem a Microsoft alkalmazottja, a jelentős változások olyan megjegyzést hoznak létre a lekéréses kérelemben, amely arra kéri, hogy küldjön be egy online Közreműködési licencszerződést (CLA). A lekéréses kérelmet csak akkor tekinthetjük át vagy fogadhatjuk el, ha előzőleg kitöltötte az online űrlapot.

Etikai kódex

A docs.microsoft.com felületen közzétevő tárházak mindegyike elfogadta a Microsoft nyílt forráskódra vonatkozó viselkedési szabályzatát vagy a .NET Foundation viselkedési szabályzatát. További információkért keresse fel a Viselkedési szabályzattal kapcsolatos gyakori kérdések oldalát,

Következő lépések

A következő cikkek a PowerShell-dokumentációval kapcsolatos információkat tartalmaznak. Ha a központi közreműködői útmutatóban található útmutatás átfedésben van, itt azt hívjuk fel, hogy ezek a szabályok miben különböznek a PowerShell-tartalom esetében.

Tekintse át az alábbi dokumentumokat:

További források