Megosztás:

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

Workflow Leírás
Szerkesztés a böngészőben Minden cikk kis, gyors szerkesztéséhez jó.
Helyi szerkesztés eszközkészlettel Alkalmas összetettebb szerkesztésre, több cikket tartalmazó szerkesztésekre és gyakori közreműködésekre.

A Data Docs tartalomért felelős csapata 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. Azon a lapon, amelyhez módosítást szeretne javasolni, válassza ki a jelen cikkben található Kebab (három függőleges pont) elemet.
  2. Válassza a Szerkesztés lehetőséget. A böngésző a cikk forrásfájljának GitHub-adattárába viszi.
  3. A forrásfájlban válassza a ceruza ikont a jobb felső sarokban. Ha ez az ikon nem jelenik meg, előfordulhat, hogy előbb be kell jelentkeznie a GitHub-fiókjába. A GitHub visszaadja a szerkesztőlapot.
  4. Módosítsa a szöveget a módosítások javaslatához. 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.
  5. A módosítások elvégzése után görgessen vissza a lap tetejére, és válassza a Módosítások véglegesítése lehetőséget.
    1. A Véglegesítés üzenet párbeszédpanelen adja meg a lekéréses kérelem nevét, például az elírás javítá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.
    3. Válassza a Módosítások ajánlása lehetőséget a Módosítások összehasonlítása lapra való ugráshoz.
  6. A Változások összehasonlítása lapon válassza a Lekéréses kérelem létrehozása lehetőséget a Lekéréses kérelem megnyitása lap megnyitásához .
  7. A Lekéréses kérelem megnyitása lapon válassza a Lekéréses kérelem létrehozása lehetőséget, hogy elküldje a lekéréses kérelmet a tartalomért felelős csapatnak.

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.

Képernyőkép az SQL Docs szerkesztéséről.

A lekéréses kérelem létrehozása után a tartalomért felelős csapat áttekinti a javasolt módosításokat. Ha elfogadják a módosításokat, egyesítik őket a dokumentációban, és közzéteszik őket. E-mailben értesítést kap a lekéréses kérelem állapotáról a GitHub értesítési beállításaitól függően.

Helyi szerkesztés eszközökkel

Egy másik lehetőség az, hogy elágazás vagy sql-docsazure-docs adattárak, és klónozza őket helyileg a gépre. 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:

Ha jelentős módosításokat tartalmazó lekéréses kérelmet küld a dokumentációban, a GitHubon megjegyzést kap, 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.

Áttekintés: sql-docs-adattár

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

Fontos

Az ebben a szakaszban szereplő információk kifejezetten a sql-docs-ra vonatkoznak. Ha sql-cikket szerkeszt az Azure dokumentációjában, tekintse meg a GitHubazure-docs adattárának Readme-ét.

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

Mappa Leírás
dokumentumok Minden közzétett SQL Server-tartalmat tartalmaz. Az almappák logikailag rendszerezik a tartalom különböző területeit.
dokumentumok/tartalmaz Tartalmazza a fájlokat. Ezek a fájlok olyan tartalomblokkok, amelyek egy vagy több más cikkben is szerepelhetnek.
./media Minden mappa rendelkezhet egy media almappával a cikkképekhez. A media mappában az almappák neve megegyezik a kép által megjelenített cikkek nevével. A képeknek olyan fájloknak kell lenniük .png , ahol az összes kisbetű és szóköz nincs.
TOC.yml Tartalomjegyzékfájl. Minden almappában lehetőség van egy TOC.yml fájl használatára.

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

Borravaló

Ha dokumentációs visszajelzés helyett termékvisszajelzést szeretne küldeni, küldjön visszajelzést.

Következő lépés

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.

  • Last updated on