Közreműködés a PowerShell dokumentációjábanContributing to PowerShell documentation

Köszönjük, hogy támogatja a PowerShellt!Thank you for your support of PowerShell!

A közreműködői útmutató egy cikkgyűjtemény, amely ismerteti a Microsoft dokumentáció létrehozásához használt eszközeit és folyamatait.The Contributor's Guide is a collection of articles that explain the tools and processes we use to create documentation at Microsoft. Ezen útmutatók némelyike a docs.microsoft.comközzétett dokumentációval kapcsolatos általános információkat tartalmazza.Some of these guides cover information that is common to any documentation set published to docs.microsoft.com. Az útmutatók némelyike kifejezetten a PowerShell dokumentációjának írására vonatkozik.Some of the guides are specific to how we write documentation for PowerShell.

A közös cikkek a központosított közreműködők útmutatójábanérhetők el.The common articles are available in our centralized Contributor's Guide. A PowerShell-specifikus útmutatók itt érhetők el.The PowerShell-specific guides are available here.

Közreműködési lehetőségekWays to contribute

Kétféleképpen lehet hozzájárulni.There are two ways to contribute. Mindkét hozzájárulás értékes nekünk.Both contributions are valuable to us.

  • A bejelentési problémák segítségével azonosíthatja a dokumentációban felmerülő problémákat és hiányosságokat.Filing issues helps us identify problems and gaps in our documentation. Időnként a problémák nehezen oldhatók fel, több vizsgálatot és kutatást igényelnek.Sometimes the issues are difficult to resolve, requiring more investigation and research. A problémás folyamat lehetővé teszi, hogy beszélgetést készítsen a problémáról, és megfelelő megoldást fejlesszen.The issue process allows us to have a conversation about the problem and develop a satisfactory resolution.

  • Az új tartalmak beküldése vagy a meglévő cikkek módosításai egy újabb folyamat.Submitting new content or changes to existing articles is a more involved process. Az alábbi információk a tartalomnak a dokumentációba való beküldéséhez szükséges eszközöket, folyamatokat és szabványokat ismertetik.The following information outlines the tools, processes, and standards for submitting content to the documentation.

Felkészülés a közreműködés elvégzésérePrepare to make a contribution

A közreműködéshez GitHub-fiókra van szükség.Contributing to the documentation requires a GitHub account. Az alábbi ellenőrzőlista segítségével lekérheti az eszközöket, és megismerheti azokat a folyamatokat, amelyeket a hozzájárulások készítéséhez használunk.Use the following checklist to get the tools and understand the processes we use for making contributions.

  1. GitHub-regisztrációSign up for GitHub
  2. Git- és Markdown-eszközök telepítéseInstall Git and Markdown tools
  3. A docs authoring Pack telepítéseInstall the Docs Authoring Pack
  4. Az Posh-git telepítése – nem kötelező, de ajánlottInstall Posh-Git - not required but recommended
  5. Helyi Git-tárház beállításaSet up a local Git repository
  6. A git és a GitHub alapjainak áttekintéseReview Git and GitHub fundamentals

A dokumentumok írásának első lépéseiGet started writing docs

A dokumentáció módosításának kétféleképpen lehet hozzájárulni:There are two ways to contribute changes to the documentation:

  1. Meglévő docs gyors szerkesztéseQuick edits to existing docs
    • Kisebb javítások, hibák javítása vagy kisebb kiegészítésekMinor corrections, fixing typos, or small additions
  2. Teljes GitHub-munkafolyamat a docs-hozFull GitHub workflow for docs
    • nagyméretű változások, több verzió, képek hozzáadása vagy módosítása vagy új cikkek beadásalarge changes, multiple versions, adding or changing images, or contributing new articles

Emellett olvassa el a központosított közreműködői útmutatójának írás alapjai című szakaszát.Also, read the Writing essentials section of the centralized Contributor's Guide. Egy másik kiváló erőforrás a Microsoft írási stílusának útmutatója.Another excellent resource is the Microsoft Writing Style Guide. A Microsoft írási stílusának célja, hogy segítse a szerkesztőket, a technikai írókat, a fejlesztőket, a marketingeseket és bárki másnak, hogy jobb tartalmat írjon.The goal of the Microsoft Writing Style Guide is to help editors, technical writers, developers, marketers, and anyone else in IT write better content.

A docs.microsoft.com használati feltételeia dokumentációra és a programkódokra vonatkozó, a nyilvános adattárakban található példák kisebb helyesbítéseit vagy pontosításait tartalmazzák.Minor corrections or clarifications to documentation and code examples in public repositories are covered by the docs.microsoft.com Terms of Use.

Jelentős változások esetén használja a teljes GitHub-munkafolyamatot.Use the full GitHub workflow when you're making significant changes. Ha nem a Microsoft egyik alkalmazottja, a jelentős változások a lekéréses kérelemben olyan megjegyzést hoznak, amely arra kéri, hogy küldjön be egy online hozzájárulási licencszerződést (CLA).If you're not an employee of Microsoft, significant changes generate a comment in the pull request that asks you to submit an online Contribution Licensing Agreement (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.We need you to complete the online form before we can review or accept your pull request.

Etikai kódexCode of conduct

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.All repositories that publish to docs.microsoft.com have adopted the Microsoft Open Source Code of Conduct or the .NET Foundation Code of Conduct. További információkért keresse fel a Viselkedési szabályzattal kapcsolatos gyakori kérdések oldalát,For more information, see the Code of Conduct FAQ.

Következő lépésekNext steps

A következő cikkek a PowerShell-dokumentációra vonatkozó információkat fedik le.The following articles cover information specific to PowerShell documentation. Ha átfedésben van a központosított közreműködők útmutatójában foglalt útmutatással, azt hívjuk, hogy ezek a szabályok miben különböznek a PowerShell-tartalomtól.Where there's overlap with the guidance in the centralized Contributor's Guide, we call out how those rules differ for the PowerShell content.

Tekintse át az alábbi dokumentumokat:Review the following documents:

További erőforrásokAdditional resources