Skip to content

Latest commit

 

History

History
95 lines (54 loc) · 4.79 KB

File metadata and controls

95 lines (54 loc) · 4.79 KB
title SQL Server docs navigation guide
description A guide 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 the how to use the version filter.
ms.date 07/11/2019
ms.prod sql
ms.reviewer
ms.custom
ms.topic conceptual
author MashaMSFT
ms.author mathoma
manager craigg
monikerRange >= aps-pdw-2016 || = azuresqldb-current || = azure-sqldw-latest || >= sql-server-2016 || >= sql-server-linux-2017 || = sqlallproducts-allversions

SQL Server docs navigation guide

This topic provides some tips and tricks for navigating the SQL Server technical documentation space.

Hub page

The SQL Server hub page can be found at https://aka.ms/sqldocs and is the entry point for finding relevant SQL Server content.

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:

SQL docs in header

Table of contents

Navigation hints

Entires in the TOC that have a > at the end of the entry indicate that you will be taken away from docs.microsoft.com.

Single carrots in toc

Entries in the TOC that have a >> indicate that you will be taken to technical documentation with a different table of contents.

TOC navigation markers

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.

Navigate back to SQL toc

Filter box

On docs.microsoft.com, you can search the content in the table of contents by using the filter search box at the top:

Use filter box

Breadcrumbs

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:

SQL Docs breadcrumbs

Version filter

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.

You can use the version filter to ensure that you are seeing content for the appropriate version and flavor of SQL Server:

SQL Docs version filter

Selecting SQL Server > Hide nothing ensures that all content is visible, and that nothing is hidden behind the version filter.

Article section navigation

The right-hand navigation pane allows you to quickly navigate to sections within an article, as well as identify your location within the article.

Right-hand navigation

Offline documentation

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.

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

Download PDF

Submit docs feedback

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.

Git Issue content feedback

You can also submit general documentation feedback and suggestions at https://aka.ms/sqldocsfeedback.

[!INCLUDEcontribute-to-content]

Next steps