Začínáme přispívání do dokumentace k PowerShellu

Tento článek popisuje, jak začít jako přispěvatel do dokumentace k PowerShellu.

struktura PowerShell-Docs

Úložiště PowerShell-Docs je rozdělené do dvou skupin obsahu: reference a konceptuální.

Vytváření odkazů na obsah

Referenční obsah je referenční informace o rutinách PowerShellu pro rutiny, které se dodávají v PowerShellu. Odkaz se shromažďuje ve složkách verzí (5.1, 7.0, 7.1 a 7.2). Tento obsah obsahuje odkazy na rutiny pouze pro moduly, které se dodávají pomocí PowerShellu. Tento obsah slouží také k vytvoření informací nápovědy zobrazených rutinou Get-Help .

Koncepční obsah

Koncepční dokumentace obsahuje následující obsah:

  • Poznámky k verzi
  • Pokyny k nastavení
  • Ukázkové skripty a články s postupy
  • Dokumentace k DSC
  • Dokumentace k sadě SDK

Koncepční dokumentace není uspořádaná podle verze. Všechny články se zobrazují pro každou verzi PowerShellu. Pracujeme na vytváření článků specifických pro verzi.

Poznámka

Kdykoli se přidá, odebere nebo přejmenuje koncepční článek, musí se obsah aktualizovat a zahrnout do žádosti o přijetí změn.

Vytváření nových článků

Pro každý nový dokument, který chcete přispívat, je potřeba vytvořit problém GitHub. Zkontrolujte stávající problémy, abyste se ujistili, že ne duplikujete úsilí. Přiřazené problémy se považují za in progress. Pokud chcete na problému spolupracovat, obraťte se na osobu přiřazenou k problému.

Podobně jako u procesu RFC PowerShellu vytvořte problém před zápisem obsahu. Problém zajistí, že nebudete ztrácet čas a úsilí při práci, která bude odmítnuta týmem PowerShell-Docs. Problém nám umožňuje poradit se s vámi o rozsahu obsahu a o tom, kde se hodí do dokumentace k PowerShellu. Všechny články musí být zahrnuty do obsahu (TOC). Navrhované umístění obsahu by mělo být součástí diskuze o problému.

Poznámka

Obsah pro referenční obsah je automaticky vygenerován systémem publikování. Nemusíte aktualizovat obsah.

Aktualizace existujících článků

V případě potřeby se referenční články rutiny duplikují ve všech verzích PowerShellu udržovaných v tomto úložišti. Při hlášení problému s referenčními informacemi k rutině nebo About_ článku je nutné určit, které verze se problém týká. Šablona problému v GitHub obsahuje kontrolní seznam verzí. Pomocí zaškrtávacích políček určete, které verze obsahu jsou ovlivněné.

Zkontrolujte všechny verze článku a zjistěte, jestli je v ostatních verzích potřeba stejná změna. Použijte příslušnou změnu pro každou verzi souboru.

Lokalizovaný obsah

Dokumentace k PowerShellu je napsaná v angličtině a přeložená do 17 dalších jazyků. Anglický obsah je uložen v úložišti GitHub s názvem MicrosoftDocs/PowerShell-Docs. Lokalizovaný obsah je uložen v samostatném úložišti pro každý jazyk. Úložiště používají stejný základní název, ale na konec přidejte název národního prostředí. Obsahuje například MicrosoftDocs/PowerShell-Docs.de-de obsah přeložený do němčiny.

Obecně platí, že problémy a změny by se měly odeslat do anglického úložiště. Všechny překlady začínají nejprve z anglického obsahu. Používáme jak lidský, tak strojový překlad.

Metoda překladu Jazyky
Překlad člověka de-DE, es-ES, fr-FR, it-IT, ja-JP, ko-KR, pt-BR, ru-RU, zh-CN, zh-TW
Strojový překlad cs-CZ, hu-HU, nl-NL, pl-PL, pt-PT, sv-SE, tr-TR

Obsah přeložený strojově přeložený nemusí vždy vést ke správnému výběru slov a gramatikě. Pokud se v překladu v libovolném jazyce místo technických podrobností článku zobrazí chyba, otevřete problém v lokalizovaném úložišti. Vysvětlete, proč si myslíte, že překlad není správný. Náš lokalizační tým kontroluje tyto problémy a reaguje na ně.

Další kroky

Existují dva běžné způsoby odesílání změn v GitHub. Obě metody jsou popsané v průvodci centrálním přispěvatelem:

  1. V GitHub webovém rozhraní můžete provádět rychlé úpravy existujících dokumentů.
  2. Použijte úplný pracovní postup GitHub pro přidávání nových článků, aktualizaci více souborů nebo jiných velkých změn.

Před zahájením jakýchkoli změn byste měli vytvořit fork úložiště PowerShell-Docs. Změny by měly být provedeny v pracovní větvi ve kopii PowerShell-Docs. Pokud používáte metodu rychlých úprav v GitHub, jsou tyto kroky zpracovány za vás. Pokud používáte úplný pracovní postup GitHub, musíte být nastaveni tak, aby fungoval místně.

Obě metody končí vytvořením žádosti o přijetí změn (PR). Další informace a osvědčené postupy najdete v tématu Odeslání žádosti o přijetí změn .