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í:

Workflow	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 Dokumentace k datům 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, pro kterou chcete navrhnout změnu, vyberte Kebab (tři svislé tečky) poblíž v tomto článku.
2. Vyberte Upravit. Prohlížeč vás přenese do úložiště GitHub pro tento zdrojový soubor článku.
3. Ve zdrojovém souboru 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. GitHub vrátí stránku pro úpravy.
4. Upravte text tak, aby navrhl změny. Pokud potřebujete pomoc s formátováním nového nebo změněného textu, podívejte se do taháku Markdownu.
5. Po provedení úprav se posuňte zpět na začátek stránky a vyberte Potvrdit změny.
   1. V dialogovém okně Potvrzení zprávy zadejte název žádosti o přijetí změn, například Oprava překlepu.
   2. Do pole Přidat volitelný rozšířený popis zadejte stručné vysvětlení změny.
   3. Výběrem možnosti Navrhnout změny přejděte na stránku Porovnání změn .
6. Na stránce Porovnání změn vyberte Vytvořit žádost o přijetí změn a přejděte na stránku Otevřít žádost o přijetí změn .
7. Na stránce Otevřít žádost o přijetí změn vyberte Vytvořit žádost o přijetí změn a odešlete žádost o přijetí změn týmu obsahu.

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

Po vytvoření žádosti o přijetí změn tým obsahu zkontroluje navrhované změny. Pokud změny přijmou, sloučí je do dokumentace a publikují je. V závislosti na nastavení oznámení GitHubu dostanete e-mailová oznámení o stavu vaší žádosti o přijetí změn.

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

Další možností je vytvořit fork sql-docs nebo azure-docs úložiště 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 na GitHubu komentář, který vás požádá o odeslání online licenční smlouvy s příspěvkem (CLA). Abyste mohli odeslat žádost o přijetí změn, musíte nejprve vyplnit online formulář.

Přehled: úložiště 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ými písmeny a bez mezer.
TOC.yml	Soubor obsahu. Každá podsložka má možnost použít jeden TOC.yml soubor.

Prostředky přispěvatele

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

Spropitné

Pokud máte místo zpětné vazby k dokumentaci zpětnou vazbu k produktu, poskytněte nám svůj názor.

Další krok

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

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

Děkuju.