Jak přispívat do dokumentace k SQL Serveru

platí pro:SQL ServerAzure SQL DatabaseAzure Synapse AnalyticsAnalytics Platform System (PDW)

Kdokoli může přispívat do dokumentace k SQL Serveru. To zahrnuje opravu překlepů, navrhování lepších vysvětlení a zlepšení technické přesnosti. Tento článek vysvětluje, jak začít s příspěvky obsahu a jak tento proces funguje.

Existují dva hlavní pracovní postupy, které můžete použít k přispívání:

Pracovní postup	Popis
Upravit v prohlížeči	Dobré pro malé, rychlé úpravy libovolného článku.
Upravit místně pomocí nástrojů	Vhodné pro složitější úpravy, úpravy zahrnující více článků a časté příspěvky.

Tým obsahu SQL ověřuje všechny veřejné příspěvky za účelem technické přesnosti a konzistence.

Úpravy v prohlížeči

V prohlížeči můžete provádět jednoduché úpravy obsahu SQL Serveru a pak je odeslat do Microsoftu. Další informace najdete v přehledu příručky pro přispěvatele.

Následující kroky shrnují proces:

1. Na stránce, na které máte zpětnou vazbu, vyberte ikonu Tužka v pravém horním rohu.
2. Na další stránce vyberte ikonu Tužka v pravém horním rohu. Pokud se tato ikona nezobrazí, možná se budete muset nejdřív přihlásit ke svému účtu GitHub.
3. Na další stránce v okně Upravit soubor textovém okně proveďte úpravy přímo na text, který chcete změnit. Pokud potřebujete pomoc s formátováním nového nebo změněného textu, podívejte se do taháku Markdownu.
4. Po provedení úprav v části Potvrdit změny:
   1. Do prvního textového pole zadejte stručný popis provedené změny.
   2. Do pole Přidat volitelný rozšířený popis zadejte stručné vysvětlení změny.
5. Vyberte Navrhnout změnu souboru.
6. Na stránce Porovnání změn vyberte Vytvořit pull request.
7. Na stránce Otevřít žádost o přijetí změn vyberte Vytvořit žádost o přijetí změn.

Následující obrázek GIF ukazuje kompletní proces odesílání změn v prohlížeči:

Místní úpravy pomocí nástrojů

Další možností úprav je vytvořit fork úložiště sql-docs nebo azure-docs a naklonovat je místně do počítače. Změny pak můžete odeslat pomocí editoru Markdownu a klienta Gitu. Tento pracovní postup je vhodný pro úpravy, které jsou složitější nebo zahrnují více souborů. Je také vhodné pro časté přispěvatele do technické dokumentace Microsoftu.

Pokud chcete přispívat pomocí této metody, přečtěte si následující články:

• vytvoření účtu GitHub
• Instalace nástrojů pro vytváření obsahu
• Nastavit Git úložiště lokálně
• Použití nástrojů k přispívání

Pokud odešlete žádost o přijetí změn s významnými změnami dokumentace, dostanete v GitHubu komentář s žádostí o odeslání online licenční smlouvy s přispěvatelem (CLA). Abyste mohli odeslat žádost o přijetí změn, musíte nejprve vyplnit online formulář.

Uznání

Pokud změny přijmete, v horní části článku jste považováni za přispěvatele.

Přehled SQL-docs

Tato část obsahuje další pokyny k práci v úložišti sql-docs.

Důležitý

Informace v této části jsou specifické pro sql-docs. Pokud upravujete článek SQL v dokumentaci k Azure, přečtěte si readme pro úložiště azure-docs na GitHubu.

Úložiště sql-docs používá k uspořádání obsahu několik standardních složek.

Složka	Popis
dokumentace	Obsahuje veškerý publikovaný obsah SQL Serveru. Podsložky logicky uspořádají různé oblasti obsahu.
docs/includes	Obsahuje soubory typu include. Tyto soubory jsou bloky obsahu, které lze zahrnout do jednoho nebo více dalších článků.
./media	Každá složka může mít jednu media podsložku pro obrázky článku. Složka media zase obsahuje podsložky se stejným názvem jako články, ve které se obrázek zobrazuje. Obrázky by měly být .png soubory se všemi malých písmeny a bez mezer.
TOC.MD	Soubor obsahu. Každá podsložka má možnost použít jeden TOC.MD soubor.

Platí pro následující

Každý článek o SQL Serveru obsahuje soubor applies-to zahrnutý za nadpisem. To označuje, na jaké oblasti nebo verze SQL Serveru se tento článek týká.

Podívejte se na následující příklad Markdownu, který načítá soubor applies-to-version/sql-asdb-asa-pdw.md include.

[!INCLUDE [SQL Server Azure SQL Database Synapse Analytics PDW](../includes/applies-to-version/sql-asdb-asdbmi-asa-pdw.md)]

Do horní části článku se přidá následující text:

Chcete-li najít vhodný soubor pro zahrnutí "applies-to" pro váš článek, použijte následující tipy:

• Seznam běžně používaných zahrnutí najdete v tématu SQL Server obsahuje soubory pro správu verzí a platí pro.
• Podívejte se na další články, které pokrývají stejnou funkci nebo související úkol. Pokud upravíte tento článek, můžete zkopírovat Markdown pro odkaz pro zahrnutí (úpravy můžete zrušit bez odeslání).
• Prohledejte docs/includes adresář pro soubory obsahující text applies-to. K rychlému filtrování můžete použít tlačítko Najít na GitHubu. Vyberte soubor a podívejte se, jak se vykresluje.
• Věnujte pozornost konvenci vytváření názvů. Pokud název obsahuje více znaků x v řetězci, obvykle jde o zástupné symboly naznačující nedostatečnou podporu pro danou službu. Například appliesto-xx-xxxx-asdw-xxx-md.md označuje podporu pouze pro Azure Synapse Analytics, protože je výslovně uvedeno pouze asdw, zatímco ostatní pole mají x.
• Některé obsahují uvedení čísla verze, například tsql-appliesto-ss2017-xxxx-xxxx-xxx-md.md. Tyto soubory použijte pouze v případech, kdy víte, že funkce byla zavedena s konkrétní verzí SQL Serveru.

Prostředky přispěvatele

• Průvodce pro přispěvatele
• Příručka stylu Microsoftu
• základy Markdownu

Spropitné

Pokud máte zpětnou vazbu k produktu namísto zpětné vazby k dokumentaci, poskytněte ji k produktu SQL Server zde.

Související obsah

Prozkoumejte úložiště sql-docs na GitHubu.

Najděte článek, odešlete změnu a pomozte komunitě SQL Serveru.

Děkuju.