Events
Mar 31, 11 PM - Apr 2, 11 PM
The biggest SQL, Fabric and Power BI learning event. March 31 – April 2. Use code FABINSIDER to save $400.
Register todayThis browser is no longer supported.
Upgrade to Microsoft Edge to take advantage of the latest features, security updates, and technical support.
Applies to:
SQL Server
Azure SQL Database
Azure Synapse Analytics
Analytics Platform System (PDW)
Anyone can contribute to SQL Server documentation. This includes correcting typos, suggesting better explanations, and improving technical accuracy. This article explains how to get started with content contributions and how the process works.
There are two main workflows you can use to contribute:
Workflow | Description |
---|---|
Edit in your browser | Good for small, quick edits of any article. |
Edit locally with tools | Good for more complex edits, edits involving multiple articles, and frequent contributions. |
SQL content team validates all public contributions for technical accuracy and consistency.
You can make simple edits to SQL Server content in your browser and then submit them to Microsoft. For more information, see the contributor guide overview.
The following steps summarize the process:
The following GIF demonstrates the end-to-end process for submitting changes in your browser:
Another editing option is to fork the sql-docs
or azure-docs
repositories and clone them locally to your machine. You can then use a Markdown editor and a git client to submit the changes. This workflow is good for edits that are more complex or involve multiple files. It's also good for frequent contributors to Microsoft technical documentation.
To contribute with this method, see the following articles:
If you submit a pull request with significant changes to documentation, you get a comment in GitHub asking you to submit an online Contribution License Agreement (CLA). You must complete the online form before your pull request can be accepted.
If your changes are accepted, you're recognized as a contributor at the top of the article.
This section provides more guidance on working in the sql-docs
repository.
Important
The information in this section is specific to sql-docs
. If you're editing a SQL article in the Azure documentation, see the Readme for the azure-docs repository on GitHub.
The sql-docs repository uses several standard folders to organize the content.
Folder | Description |
---|---|
docs | Contains all published SQL Server content. Subfolders logically organize different areas of the content. |
docs/includes | Contains include files. These files are blocks of content that can be included in one or more other articles. |
./media |
Each folder can have one media subfolder for article images. The media folder in turn has subfolders with the same name as the articles that the image appears in. Images should be .png files with all lower-case letters and no spaces. |
TOC.MD |
A table-of-contents file. Each subfolder has the option of using one TOC.MD file. |
Each SQL Server article contains an applies-to
include file after the title. This indicates what areas or versions of SQL Server the article applies to.
Consider the following Markdown example that pulls in the applies-to-version/sql-asdb-asa-pdw.md
include file.
[!INCLUDE [SQL Server Azure SQL Database Synapse Analytics PDW](../includes/applies-to-version/sql-asdb-asdbmi-asa-pdw.md)]
This adds the following text at the top of the article:
To find the correct applies-to include file for your article, use the following tips:
applies-to
. You can use the Find button in GitHub to quickly filter. Select the file to see how it renders.x
characters in the string, they're usually placeholders indicating the lack of support for a service. For example, appliesto-xx-xxxx-asdw-xxx-md.md
indicates support for only Azure Synapse Analytics, because only asdw
is spelled out, whereas the other fields have x
s.tsql-appliesto-ss2017-xxxx-xxxx-xxx-md.md
. Only use these include files when you know the feature was introduced with a specific version of SQL Server.Tip
If you have product feedback rather than documentation feedback, provide feedback on the SQL Server product here.
Explore the sql-docs repository on GitHub.
Find an article, submit a change, and help the SQL Server community.
Thank you.
Events
Mar 31, 11 PM - Apr 2, 11 PM
The biggest SQL, Fabric and Power BI learning event. March 31 – April 2. Use code FABINSIDER to save $400.
Register todayTraining
Module
Contribute to Microsoft Learn documentation in your browser - Training
Become a contributor to Microsoft Learn documentation by making edits with a web editor in GitHub. Make your changes, then create, validate, and submit pull requests to get your changes published.
Certification
Microsoft Certified: Azure Database Administrator Associate - Certifications
Administer an SQL Server database infrastructure for cloud, on-premises and hybrid relational databases using the Microsoft PaaS relational database offerings.