Skip to content

Commit 8ad17d5

Browse files
committed
Updating contributor instructions
1 parent cac22c5 commit 8ad17d5

4 files changed

Lines changed: 21 additions & 103 deletions

File tree

.openpublishing.redirection.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
{
22
"redirections": [
3+
{
4+
"source_path": "docs/sql-server/applies-to-includes.md",
5+
"redirect_url": "/sql/sql-server/sql-server-docs-contribute",
6+
"redirect_document_id": false
7+
},
38
{
49
"source_path": "docs/dma/dma-assess-sql-data-estate-to-sqldb-commandline.md",
510
"redirect_url": "/previous-versions/sql/dma/dma-assess-sql-data-estate-to-sqldb-commandline",

docs/sql-server/applies-to-includes.md

Lines changed: 0 additions & 59 deletions
This file was deleted.
-4.21 MB
Loading

docs/sql-server/sql-server-docs-contribute.md

Lines changed: 16 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -36,26 +36,29 @@ You can make simple edits to SQL Server content in your browser and then submit
3636

3737
The following steps summarize the process:
3838

39-
1. On the page you have feedback about, select the **Pencil** icon at the top right.
40-
1. On the next page, select the **Pencil** icon at the top right. If this icon doesn't appear, you might need to sign in to your GitHub account first.
41-
1. On the next page, in the **Edit file** text window, make your edits directly to the text you want to change.
39+
1. On the page you want to suggest a change for, select the **Kebab (three vertical dots)** near **In this article**.
40+
1. Select **Edit**. The browser takes you to the GitHub repository for that article source file.
41+
1. In the source file, select the **Pencil** icon at the top right. If this icon doesn't appear, you might need to sign in to your GitHub account first. GitHub returns the editing page.
42+
1. Edit the text to propose changes.
4243
If you need help with formatting the new or changed text, see the [Markdown Cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet).
43-
1. After you make your edits, under **Commit changes**:
44-
1. In the first text box, enter a brief description of the change you make.
44+
1. After you make your edits, scroll back to the top of the page and select **Commit changes**.
45+
1. In the **Commit message** dialog box, provide a name for your pull request, such as *Fixing typo*.
4546
1. In the **Add an optional extended description** box, provide a brief explanation of your change.
46-
1. Select **Propose file change**.
47-
1. On the **Comparing changes** page, select **Create pull request**.
48-
1. On the **Open a pull request** page, select **Create pull request**.
47+
1. Select **Propose changes** to go to the **Comparing changes** page.
48+
1. On the **Comparing changes** page, select **Create pull request** to go to the **Open a pull request** page.
49+
1. On the **Open a pull request page**, select **Create pull request** to submit your pull request to the content team.
4950

5051
The following GIF demonstrates the end-to-end process for submitting changes in your browser:
5152

5253
:::image type="content" source="media/sql-server-docs-navigation-guide/edit-sql-docs.gif" alt-text="Screenshot of Edit SQL Docs." lightbox="media/sql-server-docs-navigation-guide/edit-sql-docs.gif":::
5354

55+
After you create your pull request, the content team reviews your proposed changes. If they accept your changes, they merge them into the documentation and publish them. You receive email notifications about the status of your pull request, depending on your Github notification settings.
56+
5457
<a id="tools"></a>
5558

56-
## Edit locally with tools
59+
## Edit locally by using tools
5760

58-
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.
61+
Another 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.
5962

6063
To contribute with this method, see the following articles:
6164

@@ -64,17 +67,7 @@ To contribute with this method, see the following articles:
6467
- [Set up a Git repository locally](/contribute/get-started-setup-local)
6568
- [Use tools to contribute](/contribute/how-to-write-workflows-major)
6669

67-
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.
68-
69-
## Recognition
70-
71-
If your changes are accepted, you're recognized as a contributor at the top of the article.
72-
73-
:::image type="content" source="media/sql-server-docs-contribute/contribution-recognition-step-1.png" alt-text="Screenshot of Content contribution recognition under article heading." lightbox="media/sql-server-docs-contribute/contribution-recognition-step-1.png":::
74-
75-
Select the contributors link, and you can see the list of contributors in more detail.
76-
77-
:::image type="content" source="media/sql-server-docs-contribute/contribution-recognition-step-2.png" alt-text="Screenshot of Content contribution recognition dialog.":::
70+
If you submit a pull request with significant changes to documentation, you receive a comment in GitHub that asks you to submit an online **Contribution License Agreement (CLA)**. You must complete the online form before your pull request can be accepted.
7871

7972
## Overview: sql-docs repository
8073

@@ -89,38 +82,17 @@ The [sql-docs](https://github.com/MicrosoftDocs/sql-docs) repository uses severa
8982
| --- | --- |
9083
| [docs](https://github.com/MicrosoftDocs/sql-docs/tree/live/docs) | Contains all published SQL Server content. Subfolders logically organize different areas of the content. |
9184
| [docs/includes](https://github.com/MicrosoftDocs/sql-docs/tree/live/docs/includes) | Contains include files. These files are blocks of content that can be included in one or more other articles. |
92-
| `./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. |
85+
| `./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 lowercase letters and no spaces. |
9386
| `TOC.yml` | A table-of-contents file. Each subfolder has the option of using one `TOC.yml` file. |
9487

95-
#### Applies-to includes
96-
97-
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.
98-
99-
Consider the following Markdown example that pulls in the `applies-to-version/sql-asdb-asdbmi-asa-pdw-fabricsqldb.md` include file.
100-
101-
```md
102-
[!INCLUDE [SQL Server Azure SQL Database Azure SQL Managed Instance Azure Synapse Analytics Analytics Platform System (PDW) SQL database in Microsoft Fabric](../includes/applies-to-version/sql-asdb-asdbmi-asa-pdw-fabricsqldb.md)]
103-
```
104-
105-
This adds the following text to the top of the article:
106-
107-
:::image type="content" source="media/sql-server-docs-contribute/applies-to.png" alt-text="Screenshot of Applies to text." lightbox="media/sql-server-docs-contribute/applies-to.png":::
108-
109-
To find the correct applies-to include file for your article, use the following tips:
110-
111-
- For a list of commonly used includes, see [SQL Server include files for versioning and applies-to](applies-to-includes.md).
112-
- Look at other articles that cover the same feature or a related task. If you edit that article, you can copy the Markdown for the applies-to include link (you can cancel the edit without submitting it).
113-
- Search the [docs/includes](https://github.com/MicrosoftDocs/sql-docs/tree/live/docs/includes) directory for files containing the text `applies-to`. You can use the **Find** button in GitHub to quickly filter. Select the file to see how it renders.
114-
- Some includes specify a version number, such as `sql-asdbmi-asa-pdw.md`. Only use this kind of include file when you know the feature was introduced with a specific version of SQL Server.
115-
11688
## Contributor resources
11789

11890
- [Contributor guide](/contribute/)
11991
- [Microsoft Style Guide](/teamblog/style-guide)
12092
- [Markdown basics](https://docs.github.com/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github)
12193

12294
> [!TIP]
123-
> If you have product feedback rather than documentation feedback, [provide feedback](https://feedback.azure.com/forums/908035-sql-server).
95+
> If you have product feedback instead of documentation feedback, [provide feedback](https://feedback.azure.com/forums/908035-sql-server).
12496
12597
## Next step
12698

0 commit comments

Comments
 (0)