Skip to content

Commit e49bd2c

Browse files
committed
Link for applies-to
1 parent f62a17d commit e49bd2c

8 files changed

Lines changed: 73 additions & 44 deletions

File tree

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
22
author: MikeRayMSFT
33
ms.author: mikeray
4-
ms.date: 06/11/2020
4+
ms.reviewer: randolphwest
5+
ms.date: 01/24/2023
56
ms.service: sql
67
ms.topic: include
78
---
89

9-
:::image type="icon" source="../media/yes-icon.svg" border="false"::: [!INCLUDE [ssazuresynapse_sqlpool_only](../ssazuresynapse_sqlpool_only.md)]
10+
:::image type="icon" source="../media/yes-icon.svg" border="false"::: [[!INCLUDE[ssazuresynapse_sqlpool_only](../ssazuresynapse_sqlpool_only.md)]](../../sql-server/sql-docs-navigation-guide.md#applies-to)
1011

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
22
author: WilliamDAssafMSFT
33
ms.author: wiassaf
4-
ms.date: 04/09/2021
4+
ms.reviewer: randolphwest
5+
ms.date: 01/24/2023
56
ms.service: sql
67
ms.topic: include
78
---
89

9-
:::image type="icon" source="../media/yes-icon.svg" border="false"::: [!INCLUDE [ssazuresynapse_sqlpool_only](../ssazuresynapse-svrless-sqlpool-only.md)]
10+
:::image type="icon" source="../media/yes-icon.svg" border="false"::: [[!INCLUDE[ssazuresynapse_sqlpool_only](../ssazuresynapse-svrless-sqlpool-only.md)]](../../sql-server/sql-docs-navigation-guide.md#applies-to)
1011

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
22
author: MikeRayMSFT
33
ms.author: mikeray
4-
ms.date: 06/11/2020
4+
ms.reviewer: randolphwest
5+
ms.date: 01/24/2023
56
ms.service: sql
67
ms.topic: include
78
---
89

9-
:::image type="icon" source="../media/yes-icon.svg" border="false"::: [!INCLUDE [ssazuresynapse-md](../ssazuresynapse-md.md)]
10+
:::image type="icon" source="../media/yes-icon.svg" border="false"::: [[!INCLUDE[ssazuresynapse-md](../ssazuresynapse-md.md)]](../../sql-server/sql-docs-navigation-guide.md#applies-to)
1011

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
22
author: MikeRayMSFT
33
ms.author: mikeray
4-
ms.date: 06/11/2020
4+
ms.reviewer: randolphwest
5+
ms.date: 01/24/2023
56
ms.service: sql
67
ms.topic: include
78
---
89

9-
:::image type="icon" source="../media/yes-icon.svg" border="false"::: [!INCLUDE [ssazure_md](../ssazure_md.md)]
10+
:::image type="icon" source="../media/yes-icon.svg" border="false"::: [[!INCLUDE[ssazure_md](../ssazure_md.md)]](../../sql-server/sql-docs-navigation-guide.md#applies-to)
1011

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
22
author: VanMSFT
33
ms.author: vanto
4-
ms.date: 04/07/2022
4+
ms.reviewer: randolphwest
5+
ms.date: 01/24/2023
56
ms.service: sql
67
ms.topic: include
78
---
89

9-
:::image type="icon" source="../media/yes-icon.svg" border="false"::: [!INCLUDE [ssazuremi_md](../ssazuremi_md.md)]
10+
:::image type="icon" source="../media/yes-icon.svg" border="false"::: [[!INCLUDE[ssazuremi_md](../ssazuremi_md.md)]](../../sql-server/sql-docs-navigation-guide.md#applies-to)
1011

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
22
author: MikeRayMSFT
33
ms.author: mikeray
4-
ms.date: 06/11/2020
4+
ms.reviewer: randolphwest
5+
ms.date: 01/24/2023
56
ms.service: sql
67
ms.topic: include
78
---
89

9-
:::image type="icon" source="../media/yes-icon.svg" border="false"::: [!INCLUDE [ssazurepdw_md](../ssazurepdw_md.md)]
10+
:::image type="icon" source="../media/yes-icon.svg" border="false"::: [[!INCLUDE[ssazurepdw_md](../ssazurepdw_md.md)]](../../sql-server/sql-docs-navigation-guide.md#applies-to)
1011

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
author: MikeRayMSFT
33
ms.author: mikeray
4-
ms.date: 06/11/2020
4+
ms.reviewer: randolphwest
5+
ms.date: 01/24/2023
56
ms.service: sql
67
ms.topic: include
78
---
89

9-
:::image type="icon" source="../media/yes-icon.svg" border="false"::: [!INCLUDE [ssnoversion-md](../ssnoversion-md.md)] (all supported versions)
10-
10+
:::image type="icon" source="../media/yes-icon.svg" border="false"::: [[!INCLUDE[ssnoversion-md](../ssnoversion-md.md)]](../../sql-server/sql-docs-navigation-guide.md#applies-to)
Lines changed: 52 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,90 +1,113 @@
11
---
2-
title: SQL Server docs navigation tips
3-
description: Tips and tricks for navigating the SQL Server technical documentation - explains such things as the hub page, the table of contents, the header, as well as how to use the breadcrumbs and how to use the version filter.
4-
ms.date: 08/12/2020
2+
title: SQL Server docs navigation tips
3+
description: Tips and tricks for navigating the SQL Server technical documentation - explains such things as the hub page, the table of contents, the header, as well as how to use the breadcrumbs and how to use the version filter.
4+
author: MashaMSFT
5+
ms.author: mathoma
6+
ms.reviewer: randolphwest
7+
ms.date: 01/24/2023
58
ms.service: sql
69
ms.subservice: release-landing
7-
ms.reviewer: ""
8-
ms.custom: ""
910
ms.topic: conceptual
10-
author: "MashaMSFT"
11-
ms.author: "mathoma"
1211
monikerRange: ">= aps-pdw-2016 || = azuresqldb-current || = azure-sqldw-latest || >= sql-server-2016 || >= sql-server-linux-2017"
1312
---
1413
# SQL Server docs navigation guide
1514

16-
This topic provides some tips and tricks for navigating the SQL Server technical documentation space.
15+
This article provides some tips and tricks for navigating the SQL Server technical documentation space.
1716

1817
## Hub page
1918

2019
The SQL Server hub page can be found at [https://aka.ms/sqldocs](../index.yml?WT.mc_id=akams) and is the entry point for finding relevant SQL Server content.
2120

22-
You can always navigate back to this page by selecting **SQL Docs** from the header at the top of every page within the SQL Server technical documentation set:
21+
You can always navigate back to this page by selecting **SQL Docs** from the header at the top of every page within the SQL Server technical documentation set:
2322

24-
![SQL docs in header](media/sql-server-docs-navigation-guide/sql-docs-in-header.png)
23+
:::image type="content" source="media/sql-server-docs-navigation-guide/sql-docs-in-header.png" alt-text="Screenshot of the SQL Docs menu option in the header.":::
2524

2625
## Offline documentation
2726

28-
If you would like to view the SQL Server documentation on an offline system, you have two options to do so. You can either create a PDF wherever you are in the SQL Server technical documentation, or you can download the offline content using [SQL Server offline Help Viewer](./sql-server-offline-documentation.md).
27+
If you would like to view the SQL Server documentation on an offline system, you have two options to do so. You can either create a PDF wherever you are in the SQL Server technical documentation, or you can download the offline content using [SQL Server offline Help Viewer](./sql-server-offline-documentation.md).
2928

3029
If you'd like to create a PDF, select the **Download PDF** link found at the bottom of every table of contents.
3130

32-
![Download PDF](media/sql-server-docs-navigation-guide/download-pdf.png)
31+
:::image type="content" source="media/sql-server-docs-navigation-guide/download-pdf.png" alt-text="Screenshot showing the option to download content as a PDF.":::
3332

3433
## TOC symbols
3534

36-
Entries in the table of contents (TOC) that have a `>` at the end of the entry indicate that you will be taken to technical documentation with a different table of contents.
35+
Entries in the table of contents (TOC) that have a `>` at the end of the entry indicate that you'll be taken to technical documentation with a different table of contents.
3736

38-
![Single carrots in toc](media/sql-server-docs-navigation-guide/single-carrots-in-sql-docs-toc.png)
37+
:::image type="content" source="media/sql-server-docs-navigation-guide/single-carrots-in-sql-docs-toc.png" alt-text="Screenshot showing a single chevron item in table of contents.":::
3938

40-
Entries in the TOC marked with **>>** indicate that you will be taken to a different website.
39+
Entries in the TOC marked with `>>` indicate that you'll be taken to a different website.
4140

42-
![TOC navigation markers](media/sql-server-docs-navigation-guide/double-carrots-in-sql-docs-toc.png)
41+
:::image type="content" source="media/sql-server-docs-navigation-guide/double-carrots-in-sql-docs-toc.png" alt-text="Screenshot showing double-chevron table of contents navigation markers.":::
4342

44-
If you navigate to one of these pages, you can come back to the main SQL Server technical page, and table of contents, by selecting the **Welcome to SQL Server >** entry found at the top of each of these table of contents.
43+
If you navigate to one of these pages, you can come back to the main SQL Server technical page, and table of contents, by selecting the **Welcome to SQL Server >** entry found at the top of each of the table of contents.
4544

46-
![Navigate back to SQL toc](media/sql-server-docs-navigation-guide/navigate-back-to-sql-toc.png)
45+
:::image type="content" source="media/sql-server-docs-navigation-guide/navigate-back-to-sql-toc.png" alt-text="Screenshot showing the option to navigate back to SQL Docs table of contents.":::
4746

4847
## TOC search
4948

5049
You can search the entries in the table of contents using the filter search box at the top:
5150

52-
![Use filter box](media/sql-server-docs-navigation-guide/sql-docs-toc-filter.gif)
51+
:::image type="content" source="media/sql-server-docs-navigation-guide/sql-docs-toc-filter.gif" alt-text="Screenshot showing the option to use the filter box.":::
5352

5453
## Version filter
55-
The SQL Server technical documentation provides content for several supported versions and flavors of SQL Server. Features can vary between versions and flavors of SQL Server, and as such, sometimes the content itself can vary.
5654

57-
You can use the [version filter](versioning-system-monikers-ui-sql-server.md) to ensure that you are seeing content for the appropriate version and flavor of SQL Server:
55+
The SQL Server technical documentation provides content for several supported versions and flavors of SQL Server. Features can vary between versions and flavors of SQL Server, and as such, sometimes the content itself can vary.
5856

59-
![SQL Docs version filter](media/sql-server-docs-navigation-guide/sql-docs-version-filter.gif)
57+
You can use the [version filter](versioning-system-monikers-ui-sql-server.md) to ensure that you're seeing content for the appropriate version and flavor of SQL Server:
58+
59+
:::image type="content" source="media/sql-server-docs-navigation-guide/sql-docs-version-filter.gif" alt-text="Screenshot showing the SQL Docs version filter.":::
6060

6161
## Breadcrumbs
6262

6363
Breadcrumbs can be found below the header and above the table of contents, and indicate where the current article is located in the table of contents. Not only does this help set the context to what type of content you're reading, but it also allows you to navigate back up the table of contents tree:
6464

65-
![SQL Docs breadcrumbs](media/sql-server-docs-navigation-guide/sql-docs-bread-crumbs.gif)
65+
:::image type="content" source="media/sql-server-docs-navigation-guide/sql-docs-bread-crumbs.gif" alt-text="Screenshot showing the SQL Docs breadcrumbs.":::
6666

6767
## Article section navigation
6868

69-
The right-hand navigation pane allows you to quickly navigate to sections within an article, as well as identify your location within the article.
69+
The right-hand navigation pane allows you to quickly navigate to sections within an article, and identify your location within the article.
70+
71+
:::image type="content" source="media/sql-server-docs-navigation-guide/sql-docs-right-hand-navigation.gif" alt-text="Screenshot showing right-hand navigation.":::
72+
73+
## <a id="applies-to"></a> What the "Applies to" options mean
74+
75+
At the top of every article in SQL Docs, you'll see a section after the heading to explain which products the article applies to.
76+
77+
The SQL Docs content covers several product lines that work on-premises and in the cloud, and it can be confusing to differentiate between products. The following table describes several common options, but isn't exhaustive.
78+
79+
| Product | Deployment model | Description |
80+
| --- | --- | --- |
81+
| **SQL Server** | On-premises <sup>1</sup>, Azure Virtual Machines <sup>3</sup>, Linux containers <sup>1</sup> | This is [!INCLUDE [ssnoversion-md](../includes/ssnoversion-md.md)] that you have full control over. You can install SQL Server on Windows or [Linux](../linux/sql-server-linux-overview.md), deploy it in [a Linux container](../linux/sql-server-linux-overview.md#container-images), or deploy it on an [Azure Virtual Machine](/azure/azure-sql/virtual-machines/windows/sql-server-on-azure-vm-iaas-what-is-overview) or other virtual machine platform. You may previously have referred to this as the *boxed product*.<br /><br />Supported versions of [!INCLUDE [ssnoversion-md](../includes/ssnoversion-md.md)] depend on your license agreement, but for the purposes of this documentation, we mean [!INCLUDE [sssql16-md](../includes/sssql16-md.md)] and later versions. For [!INCLUDE [sssql14-md](../includes/sssql14-md.md)] and older documentation, see [Previous versions of SQL Server documentation](previous-versions-sql-server.md). To find out which versions of [!INCLUDE [ssnoversion-md](../includes/ssnoversion-md.md)] are currently supported, see [SQL Server end of support options](end-of-support/sql-server-end-of-support-overview.md).<br /><br />**Important:** Doesn't include Azure SQL support. If an article relates to [Azure SQL products](/azure/azure-sql/azure-sql-iaas-vs-paas-what-is-overview), those products will be listed separately in the "Applies to" section. |
82+
| **Azure SQL Database** | Fully managed <sup>2</sup> | [Azure SQL Database](/azure/azure-sql/database/) is a single database, or part of an elastic pool. SQL Database is a fully managed platform-as-a-service (PaaS) database engine that handles most database management functions such as upgrading, patching, backups, and monitoring, without user involvement. |
83+
| **Azure SQL Managed Instance** | Fully managed <sup>2</sup> | [Azure SQL Managed Instance](/azure/azure-sql/managed-instance/) is a fully managed database instance. SQL Managed Instance combines the broadest SQL Server database engine compatibility with all the benefits of a fully managed and evergreen platform-as-a-service (PaaS). SQL Managed Instance has near 100 percent compatibility with the latest SQL Server (Enterprise Edition) database engine.<br /><br />**Important:** Although SQL Managed Instance shares many features with [!INCLUDE [ssnoversion-md](../includes/ssnoversion-md.md)], there are [some incompatibilities](/azure/azure-sql/managed-instance/transact-sql-tsql-differences-sql-server), especially prior to [!INCLUDE [sssql22-md](../includes/sssql22-md.md)]. |
84+
| **Azure Synapse Analytics** | Fully managed <sup>2</sup> | [Azure Synapse Analytics](/azure/synapse-analytics/overview-what-is) is an enterprise analytics service that accelerates time to insight across data warehouses and big data systems. Azure Synapse Analytics brings together the best of SQL technologies used in enterprise data warehousing, Spark technologies used for big data, Data Explorer for log and time series analytics, Pipelines for data integration and ETL/ELT, and deep integration with other Azure services such as Power BI, Cosmos DB, and AzureML. The [Azure Synapse SQL](/azure/synapse-analytics/sql/overview-architecture) features provide scale-out architecture for data processing in the form of dedicated SQL pools (formerly SQL DW) and serverless SQL pools. |
85+
| **Analytics Platform System (PDW)** | On-premises, Fully managed <sup>2</sup> |[Microsoft Analytics Platform System (APS)](../analytics-platform-system/home-analytics-platform-system-aps-pdw.md) is a data platform designed for data warehousing and Big Data analytics, offers deep data integration, high-speed query processing, highly scalable storage, and simple maintenance for your end-to-end business intelligence solutions. Analytics Platform System hosts SQL Server Parallel Data Warehouse (PDW), which is the software that runs the massively parallel processing (MPP) data warehouse. |
86+
| **Azure SQL Edge** | *Connected* mode using Azure IoT Edge, or *disconnected* mode in a Linux container | [Azure SQL Edge](/azure/azure-sql-edge/overview) is an optimized relational database engine geared for IoT and IoT Edge deployments. It provides capabilities to create a high-performance data storage and processing layer for IoT applications and solutions. It shares the same database engine as [!INCLUDE [ssnoversion-md](../includes/ssnoversion-md.md)], and includes additional time-series and analytics features. |
87+
| **Azure Database for MariaDB** | Fully managed <sup>2</sup> | A relational database service based on the MariaDB open-source database engine. A fully managed database-as-a-service (DBaaS) that can handle mission-critical workloads with predictable performance, security, high availability, and dynamic scalability. |
88+
| **Azure Database for MySQL** | Fully managed <sup>2</sup> | A relational database service based on the MySQL open-source database engine. A fully managed database-as-a-service (DBaaS) that can handle mission-critical workloads with predictable performance, security, high availability, and dynamic scalability. |
89+
| **Azure Database for PostgreSQL** | Fully managed <sup>2</sup> | A relational database service based on the PostgreSQL open-source database engine. A fully managed database-as-a-service (DBaaS) that can handle mission-critical workloads with predictable performance, security, high availability, and dynamic scalability. |
90+
91+
<sup>1</sup> Can be Azure Arc-enabled
7092

71-
![Right-hand navigation](media/sql-server-docs-navigation-guide/sql-docs-right-hand-navigation.gif)
93+
<sup>2</sup> Platform-as-a-service (PaaS)
7294

95+
<sup>3</sup> Infrastructure-as-a-service (IaaS)
7396

7497
## Submit docs feedback
7598

7699
If you find something wrong within an article, you can submit feedback to the SQL Content team for that article by scrolling down to the bottom of the page and selecting **Content feedback**.
77100

78-
![Git Issue content feedback](media/sql-server-get-help/git-issues.png)
101+
:::image type="content" source="media/sql-server-get-help/git-issues.png" alt-text="Screenshot showing GitHub issue content feedback.":::
79102

80-
You can also submit general documentation feedback and suggestions at [https://aka.ms/sqldocsfeedback](https://aka.ms/sqldocsfeedback).
103+
You can also submit general documentation feedback and suggestions at <https://aka.ms/sqldocsfeedback>.
81104

82105
[!INCLUDE[contribute-to-content](../includes/paragraph-content/contribute-to-content.md)]
83106

84-
![Edit SQL Docs](media/sql-server-docs-navigation-guide/edit-sql-docs.gif)
107+
:::image type="content" source="media/sql-server-docs-navigation-guide/edit-sql-docs.gif" alt-text="Screenshot showing the option to edit SQL Docs.":::
85108

86109
## Next steps
87110

88111
- Get started with the [SQL Server technical documentation](index.yml).
89-
- For more information about submitting feedback for or getting help with SQL Server, see the [Get help](sql-server-get-help.md) page.
112+
- For more information about submitting feedback for or getting help with SQL Server, see the [Get help](sql-server-get-help.md) page.
90113
- To quickly access all the quickstarts and tutorials, see [Educational SQL resources](../sql-server/educational-sql-resources.yml).

0 commit comments

Comments
 (0)