Dela via

Så här bidrar du till SQL Server-dokumentationen

  • Artikel

gäller för:SQL ServerAzure SQL DatabaseAzure Synapse AnalyticsAnalytics Platform System (PDW)

Vem som helst kan bidra till SQL Server-dokumentationen. Detta inkluderar att korrigera stavfel, föreslå bättre förklaringar och förbättra den tekniska noggrannheten. Den här artikeln beskriver hur du kommer igång med innehållsbidrag och hur processen fungerar.

Det finns två huvudsakliga arbetsflöden som du kan använda för att bidra:

Arbetsflöde Beskrivning
Redigera i webbläsarens Bra för små, snabba redigeringar av alla artiklar.
Redigera lokalt med verktyg Bra för mer komplexa redigeringar, redigeringar med flera artiklar och frekventa bidrag.

SQL-innehållsteamet validerar alla offentliga bidrag för teknisk noggrannhet och konsekvens.

Redigera i webbläsaren

Du kan göra enkla ändringar av SQL Server-innehåll i webbläsaren och sedan skicka dem till Microsoft. Mer information finns i översikt över bidragsgivarguide.

Följande steg sammanfattar processen:

  1. På sidan som du har feedback om väljer du ikonen Penna längst upp till höger.
  2. På nästa sida väljer du pennikonen längst upp till höger. Om den här ikonen inte visas kan du behöva logga in på ditt GitHub-konto först.
  3. På nästa sida i fönstret Redigera fil text gör du dina ändringar direkt till den text som du vill ändra. Om du behöver hjälp med att formatera den nya eller ändrade texten kan du läsa Markdown Cheatsheet.
  4. När du har redigerat under Genomför ändringar:
    1. I den första textrutan anger du en kort beskrivning av den ändring du gör.
    2. I rutan Lägg till en valfri utökad beskrivning anger du en kort förklaring av ändringen.
  5. Välj Föreslå filändring.
  6. På sidan Jämföra ändringar väljer du Skapa pull-förfrågan.
  7. På sidan Öppna en pull-begäran väljer du Skapa pull-begäran.

Följande GIF visar processen från slutpunkt till slutpunkt för att skicka ändringar i webbläsaren:

Skärmbild av Redigera SQL Docs.

Redigera lokalt med verktyg

Ett annat redigeringsalternativ är att göra en kopia av sql-docs eller azure-docs-repositoryt och klona dem lokalt till din dator. Du kan sedan använda en Markdown-redigerare och en git-klient för att skicka ändringarna. Det här arbetsflödet är bra för redigeringar som är mer komplexa eller omfattar flera filer. Det är också bra för regelbundna bidragsgivare till Microsofts tekniska dokumentation.

Information om hur du bidrar med den här metoden finns i följande artiklar:

Om du skickar en pull-begäran med betydande ändringar i dokumentationen får du en kommentar i GitHub där du uppmanas att skicka in ett licensavtal för bidrag online (CLA). Du måste fylla i onlineformuläret innan pull-begäran kan godkännas.

Erkännande

Om dina ändringar godkänns identifieras du som deltagare överst i artikeln.

Skärmbild av igenkänning av innehållsbidrag.

Översikt över SQL-docs

Det här avsnittet innehåller mer vägledning om hur du arbetar på den sql-docs lagringsplatsen.

Viktig

Informationen i det här avsnittet är specifik för sql-docs. Om du redigerar en SQL-artikel i Azure-dokumentationen kan du läsa Readme för azure-docs-lagringsplatsen på GitHub.

Lagringsplatsen sql-docs använder flera standardmappar för att organisera innehållet.

Mapp Beskrivning
dokument Innehåller allt publicerat SQL Server-innehåll. Undermappar organiserar logiskt olika delar av innehållet.
dokument/innehåller Innehåller include-filer. Dessa filer är innehållsblock som kan ingå i en eller flera andra artiklar.
./media Varje mapp kan ha en media undermapp för artikelbilder. Den media mappen i sin tur har undermappar med samma namn som de artiklar som bilden visas i. Bilder ska vara .png-filer och använda endast gemener utan blanksteg.
TOC.MD En innehållsförteckningsfil. Varje undermapp har möjlighet att använda en TOC. MD-fil.

Gäller för

Varje artikel om SQL Server innehåller en applies-to-inklusionsfil efter rubriken. Detta anger vilka områden eller versioner av SQL Server som artikeln gäller för.

Tänk dig följande Markdown-exempel som hämtar applies-to-version/sql-asdb-asa-pdw.md inkludera filen.

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

Detta lägger till följande text överst i artikeln:

Skärmbild av Gäller för text.

Använd följande råd för att hitta rätt fil att inkludera för din artikel.

  • En lista över vanligt använda inkluderingsfiler finns under SQL Server include-filer för versionskontroll och tillämpning på.
  • Titta på andra artiklar som täcker samma funktion eller en relaterad uppgift. Om du redigerar den artikeln kan du kopiera Markdown-kod för länken "applies-to include" (du kan avbryta redigeringen utan att skicka in den).
  • Sök i katalogen docs/includes efter filer som innehåller texten applies-to. Du kan använda knappen Hitta i GitHub för att snabbt filtrera. Välj filen för att se hur den återges.
  • Var uppmärksam på namngivningskonventionen. Om namnet innehåller flera x tecken i strängen är de vanligtvis platshållare som anger bristen på stöd för en tjänst. Till exempel anger appliesto-xx-xxxx-asdw-xxx-md.md endast stöd för Azure Synapse Analytics, eftersom endast asdw stavas, medan de andra fälten har xs.
  • Vissa inkluderar att ange ett versionsnummer, till exempel tsql-appliesto-ss2017-xxxx-xxxx-xxx-md.md. Använd endast dessa inkluderingsfiler när du vet att funktionen introducerades med en viss version av SQL Server.

Deltagarresurser

Tips

Om du har produktfeedback i stället för feedback från dokumentationen ge feedback om SQL Server-produkten här.

Relaterat innehåll

Utforska sql-docs-lagringsplats på GitHub.

Hitta en artikel, skicka en ändring och hjälp SQL Server-communityn.

Tack.