Přispívání do dokumentace k PowerShellu

Děkujeme za vaši podporu PowerShellu.

Průvodce pro přispěvatele je kolekce článků, které popisují nástroje a procesy, které používáme k vytvoření dokumentace v Microsoftu. Některé z těchto příruček obsahují informace, které jsou společné pro jakoukoli dokumentační sadu publikovanou na learn.microsoft.com. Další příručky jsou specifické pro to, jak píšeme dokumentaci pro PowerShell.

Běžné články jsou k dispozici v naší centralizované příručce pro přispěvatele. Příručky specifické pro PowerShell jsou k dispozici tady.

Způsoby přispívání

Existují dva způsoby, jak přispívat. Oba příspěvky jsou pro nás cenné.

  • Problémy s vyplňování nám pomáhají identifikovat problémy a mezery v naší dokumentaci. Někdy je obtížné tyto problémy vyřešit, což vyžaduje další šetření a výzkum. Proces problému nám umožňuje diskutovat o problému a rozvíjet uspokojivé řešení.

  • Odeslání žádosti o přijetí změn pro přidání nebo změnu obsahu je složitější proces. Následující informace popisují nástroje, procesy a standardy pro odesílání obsahu do dokumentace.

Příprava na příspěvek

Přispívání do dokumentace vyžaduje účet GitHubu. Pomocí následujícího kontrolního seznamu nainstalujte a nakonfigurujte nástroje, které potřebujete k přispívání.

  1. Registrace k GitHubu
  2. Instalace nástrojů Git a Markdown
  3. Instalace balíčku pro vytváření obsahu na webu Docs
  4. Instalace Posh-Git – nevyžaduje se, ale doporučuje se
  5. Nastavení místního úložiště Git
  6. Seznámení se základy Gitu a GitHubu

Začínáme s psaním dokumentace

Změny v dokumentaci můžete přispívat dvěma způsoby:

  1. Rychlé úpravy existujících dokumentů – menší opravy, oprava překlepů nebo malé doplňky
  2. Úplný pracovní postup GitHubu pro dokumenty – velké změny, více verzí, přidávání nebo změny obrázků nebo přispívání nových článků

Přečtěte si také část Základy psaní z centralizovaného průvodce pro přispěvatele. Dalším vynikajícím zdrojem je Průvodce stylem psaní microsoftu.

Menší opravy nebo objasnění dokumentace a příkladů kódu ve veřejných úložištích se týkají learn.microsoft.com podmínek použití.

Pokud provádíte významné změny, použijte úplný pracovní postup GitHubu. Pokud nejste zaměstnancem společnosti Microsoft, náš systém ověřování PR přidá do žádosti o přijetí změn komentář a vyzve vás k podepsání online licenční smlouvy o příspěvku (CLA). Tento krok musíte dokončit, než budeme moct vaši žádost o přijetí změn zkontrolovat nebo přijmout. Podepsání CLA se vyžaduje jenom při prvním odeslání žádosti o přijetí změn (PR) v úložišti. Může se zobrazit výzva k podpisu CLA při každém přispění do nového úložiště.

Pravidla chování

Všechna úložiště, která publikují do microsoft Learn, dodržují pravidla chování microsoftu open source nebo pravidla chování pro .NET Foundation. Další informace najdete v nejčastějších dotazech k kodexu chování.

Další kroky

Následující články se týkají informací specifických pro dokumentaci k PowerShellu. Tam, kde se překrývají s pokyny v příručce centralizovaného přispěvatele, označujeme, jak se tato pravidla liší pro obsah PowerShellu.

Prostudujte si následující dokumenty:

Další zdroje informací

  • Last updated on