Közreműködés az SQL Server dokumentációjában

A következőkre vonatkozik:SQL ServerAzure SQL DatabaseAzure Synapse AnalyticsAnalytics Platform System (PDW)

Bárki közreműködhet az SQL Server dokumentációjában. Ez magában foglalja az elírások kijavítását, a jobb magyarázatok javaslatát és a műszaki pontosság javítását. Ez a cikk bemutatja, hogyan kezdheti el a tartalombevallással és a folyamat működésével kapcsolatos lépéseket.

A közreműködéshez két fő munkafolyamat használható:

Az SQL-tartalomért felelős csapat ellenőrzi az összes nyilvános hozzájárulást a technikai pontosság és a konzisztencia érdekében.

Szerkesztés a böngészőben

A böngészőben egyszerűen szerkesztheti az SQL Server-tartalmakat, majd elküldheti őket a Microsoftnak. További információ: közreműködői útmutató áttekintése.

A következő lépések összefoglalják a folyamatot:

1. A visszajelzést tartalmazó lapon válassza a jobb felső sarokban található Ceruza ikont.
2. A következő lapon válassza a jobb felső sarokban található Ceruza ikont. Ha ez az ikon nem jelenik meg, előfordulhat, hogy előbb be kell jelentkeznie a GitHub-fiókjába.
3. A következő lapon, a Fájl szerkesztése szövegablakban végezze el a módosításokat közvetlenül a módosítani kívánt szövegre. Ha segítségre van szüksége az új vagy módosított szöveg formázásához, tekintse meg a Markdown-adatlap.
4. A szerkesztések elvégzése után véglegesítse a változtatásokat itt: Commit changes.
   1. Az első szövegmezőbe írja be a módosítás rövid leírását.
   2. A Adjon hozzá egy opcionális kiterjesztett leírást mezőben adja meg a módosítás rövid leírását.
5. Válassza a Fájlváltoztatási javaslatlehetőséget.
6. A Módosítások összehasonlítása lapon válassza a Lekéréses kérelem létrehozásalehetőséget.
7. A Lekéréses kérelem megnyitása oldalon válassza a Lekéréses kérelem létrehozásalehetőséget.

Az alábbi GIF bemutatja a módosítások böngészőben történő elküldési folyamatát az elejétől a végéig.

Helyi szerkesztés eszközökkel

Egy másik szerkesztési lehetőség a sql-docs vagy azure-docs adattárak kiágaztatása és helyi klónozása a gépedre. Ezután egy Markdown-szerkesztővel és egy git-ügyféllel küldheti el a módosításokat. Ez a munkafolyamat olyan szerkesztésekhez használható, amelyek összetettebbek vagy több fájlt is érintenek. A Microsoft műszaki dokumentációjának gyakori közreműködői számára is hasznos.

Ezzel a módszerrel való közreműködéshez tekintse meg a következő cikkeket:

• GitHub-fiók létrehozása
• Tartalomkészítő eszközök telepítése
• Git-adattár helyi beállítása
• Eszközök használata a hozzájáruláshoz

Ha jelentős módosításokat tartalmazó lekéréses kérelmet küld a dokumentációban, megjegyzést kap a GitHubon, amely arra kéri, hogy küldjön be egy online hozzájárulási licencszerződést (CLA). A lekéréses kérelem elfogadása előtt ki kell töltenie az online űrlapot.

Elismerés

Ha elfogadja a módosításokat, a rendszer a cikk tetején közreműködőként ismeri fel Önt.

AZ SQL-dokumentumok áttekintése

Ez a szakasz további útmutatást nyújt a sql-docs adattárban való munkához.

Az sql-docs adattár több szabványos mappát használ a tartalom rendszerezéséhez.

Vonatkozik a következőkre:

Minden SQL Server-cikk egy applies-to fájlt tartalmaz a cím után. Ez azt jelzi, hogy az SQL Server mely területeire vagy verzióira vonatkozik a cikk.

Tekintse az alábbi Markdown-példát, amely lekéri a applies-to-version/sql-asdb-asa-pdw.md include fájlt.

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

Ez a cikk tetején a következő szöveget adja hozzá:

A cikkhez megfelelő vonatkozó fájl megkereséséhez használja az alábbi tippeket:

• A gyakran használt inklúdfájlok listájáért lásd: SQL Server inklúdfájlok a verziószámozáshoz és az alkalmazási területekhez.
• Tekintse meg azokat a cikkeket, amelyek ugyanarra a funkcióra vagy egy kapcsolódó feladatra vonatkoznak. Ha szerkeszted a cikket, átmásolhatod a Markdownt a vonatkozó beillesztési linkhez (a szerkesztést megszakíthatod anélkül, hogy elküldenéd).
• Keresse a és könyvtárakban a applies-toszöveget tartalmazó fájlokat. A keresése gomb segítségével gyorsan szűrhet a GitHubon. Válassza ki a fájlt a megjelenítési módjának megtekintéséhez.
• Ügyeljen az elnevezési konvenciókra. Ha a név több x karaktert tartalmaz a karakterláncban, azok általában helyőrzők, amelyek azt jelzik, hogy a szolgáltatás nem támogatott. Például a appliesto-xx-xxxx-asdw-xxx-md.md csak az Azure Synapse Analytics támogatását jelzi, mert csak a asdw van kiemelve, míg a többi mező xtartalmaz.
• Néhány tartalmazza a verziószám megadását, például tsql-appliesto-ss2017-xxxx-xxxx-xxx-md.md. Csak akkor használja ezeket a fájlokat, ha tudja, hogy a funkció az SQL Server egy adott verziójával lett bevezetve.

Közreműködői erőforrások

• közreműködői útmutató
• Microsoft Stílus Útmutató
• Markdown alapjai

Kapcsolódó tartalom

Ismerkedjen meg a GitHubon található sql-docs-adattár.

Keressen egy cikket, küldjön be egy módosítást, és segítsen az SQL Server közösségének.

Köszönöm.