Skip to content

Commit 1656348

Browse files
author
MightyPen
committed
RothJa requested changes to versioning-system-monikers-ui-sql-server.md (old PRs 11446, 11475).
1 parent eda660a commit 1656348

10 files changed

Lines changed: 174 additions & 122 deletions
214 KB
Loading
File renamed without changes.

docs/toc/media/versioning-control-30-viewfallbackfrom.png renamed to docs/sql-server/media/versioning-control-30-viewfallbackfrom.png

File renamed without changes.

docs/sql-server/sql-docs-navigation-guide.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,8 @@ ms.custom: ""
88
ms.topic: conceptual
99
author: "MashaMSFT"
1010
ms.author: "mathoma"
11-
manager: craigg
1211
monikerRange: ">= aps-pdw-2016 || = azuresqldb-current || = azure-sqldw-latest || >= sql-server-2016 || >= sql-server-linux-2017 || = sqlallproducts-allversions"
1312
---
14-
1513
# SQL Server docs navigation guide
1614

1715
This topic provides some tips and tricks for navigating the SQL Server technical documentation space.
@@ -56,11 +54,11 @@ On docs.microsoft.com, you can search the content in the table of contents by us
5654
## Version filter
5755
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-
You can use the version filter to ensure that you are seeing content for the appropriate version and flavor of SQL Server:
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:
6058

6159
![SQL Docs version filter](media/sql-server-docs-navigation-guide/sql-docs-version-filter.gif)
6260

63-
Selecting **All SQL** > **Hide nothing** ensures that all content is visible, and that nothing is hidden behind the version filter.
61+
Selecting **All SQL** \> **Hide nothing** ensures that all content is visible, and that nothing is hidden by the version filter. The [**Hide nothing** option is not recommended](versioning-system-monikers-ui-sql-server.md#anchor-allsql-hidenothing) for routine use.
6462

6563
## Breadcrumbs
6664

docs/sql-server/sql-server-technical-documentation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ SQL Server 2014, and older versions including SQL Server 2005, have documentatio
149149

150150
The _versioning control_ on this :::no-loc text="Docs"::: webpage is above the table of contents. For information about how you can use the versioning control and exactly what it does, see:
151151

152-
- [Versioning system for SQL documentation](../toc/versioning-system-monikers-ui-sql-server.md)
152+
- [Versioning system for SQL documentation](versioning-system-monikers-ui-sql-server.md)
153153

154154
<!--
155155
The following includes/ files contain their own H2 headers.
Lines changed: 164 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,164 @@
1+
---
2+
title: "Versioning system SQL docs | Microsoft Docs"
3+
ms.date: "08/09/2019"
4+
ms.prod: sql
5+
ms.technology: ""
6+
ms.custom: ""
7+
ms.topic: conceptual
8+
ms.reviewer: ""
9+
author: MightyPen
10+
ms.author: genemi
11+
monikerRange: "=azuresqldb-current||=azuresqldb-mi-current||=azure-sqldw-latest||>=aps-pdw-2016||>=sql-server-linux-2017||>=sql-server-previousversions||=sqlallproducts-allversions"
12+
---
13+
# Versioning system for SQL documentation
14+
15+
[!INCLUDE[includes_appliesto-ss-asdb-asdw-pdw-md.md](../includes/appliesto-ss-asdb-asdw-pdw-md.md)]
16+
17+
This article explains our _versioning system_ for SQL documentation. The versioning system knows about products and their versions. The system enables you to choose the product and version you are interested in. The system then displays the appropriate documentation.
18+
19+
## APPLIES TO products
20+
21+
Most of the SQL Server articles have the words **APPLIES TO** under their title. On the same line, there follows a handy listing of SQL _products_ with indicators of whether the article is relevant to the product. For example, the product SQL Server could be indicated as relevant, while Azure SQL Database could be indicated as irrelevant to the article.
22+
23+
The **APPLIES TO** line does not know about _versions_ of products. We strive to avoid discrepancies between the **APPLIES TO** line and the products aspect of our versioning system configurations.
24+
25+
## History of separate file sets
26+
27+
For SQL Server 2014 and earlier versions, each version has its own full separate copy of the documentation files. For instance, the documentation for SQL Server 2014 began as a copy of the documentation for SQL Server 2012. The 2014 copy was then edited during the product development cycle.
28+
29+
This old approach meant that if a flaw was discovered in the 2014 documentation, the flaw might also exist in 2012 and 2008. This made fixing flaws and general maintenance more difficult.
30+
31+
## Multiple versions in the same files
32+
33+
For this reason and others, the documentation files for SQL Server 2016 are also for 2017, 2019, and probably for \<vNext\>. This consolidation is made practical because we now assign _versioning monikers_ to our SQL Server documentation files. The versioning monikers are assigned, or are explicitly embedded, at whatever degree of granularity makes sense for each given documentation file.
34+
35+
## Versioning control in the UI
36+
37+
When you view any SQL documentation article by using our :::no-loc text="Docs"::: website, the currently chosen versioning moniker is visible above the table of contents (TOC). The control is a drop-down list.
38+
39+
![media_versioning-control-10-sql-server-2017.png](media/versioning-control-10-sql-server-2017.png)
40+
41+
If you want to see the documentation for a different version of SQL Server, you click the expander arrow located at the end of the current version moniker. Then click to choose any product and version combination you want. When you click a different version, the displayed documentation suddenly changes to show the differences for the newly chosen version. There might or might not be any changes, and both cases are common.
42+
43+
![media_versioning-control-20-expanded.png](media/versioning-control-20-expanded.png)
44+
45+
### HTTPS parameter :::no-loc text="view=":::
46+
47+
Each article whose web address begins with `https://docs.microsoft.com/sql/` has a parameter named `?view=` appended to its address. This parameter value is the versioning moniker code.
48+
49+
The moniker _code_ in the `https` address always matches the moniker _name_ that is displayed in the versioning control.
50+
51+
## Products, not editions
52+
53+
### Editions
54+
55+
In the 1990s and into the 2000s, Microsoft SQL Server had only one product. There were various _editions_ of each version of SQL Server, such as the _Developer_ and _Enterprise_ editions of SQL Server 2008. The editions represented slightly different feature sets, but the core product was the same. New SQL Server releases may still have a variety of editions.
56+
57+
### Products
58+
59+
With the more recent rise of cloud computing and Microsoft Azure, Microsoft released its Azure SQL Database product. While there is much code shared by both the traditional SQL Server on-premises product and the Azure SQL Database product, these products are two truly separate products.
60+
61+
For SQL, versioning monikers make distinctions between products, but not between editions.
62+
63+
#### Azure cloud SQL products
64+
65+
For articles whole web addresses start with `https://docs.microsoft.com/sql/`, almost all apply to at least one version of the product named SQL Server. A large subset of those articles also apply to one or more of our SQL service products that are hosted in our Azure cloud. One such SQL cloud product is named Azure SQL Database.
66+
67+
Naturally, the Azure SQL Database product has only one version. Almost all the articles that apply to Azure SQL Database, but not to SQL Server, have web addresses starting with `https://docs.microsoft.com/azure/sql-database/`.
68+
69+
## Scenarios of version filtering
70+
71+
The versioning system works by filtering out all documentation content that does not apply to the currently active moniker. Each time you choose a different versioning moniker, set of content that is hidden changes. The filtering hides content at the following levels:
72+
73+
- Sections or sentences within an article.
74+
- Entries for articles in the table of contents (TOC).
75+
76+
Next are scenarios that explain the effects of choosing a different moniker.
77+
78+
### Scenario 1: Within the current article
79+
80+
The following scenario focuses on sections within your current article:
81+
82+
1. The current versioning moniker is **SQL Server 2017**.
83+
2. You are reading a section that describes a feature that was first added to version 2017 of SQL Server.
84+
3. You change the moniker to **SQL Server 2016**.
85+
4. You notice the section you were reading is gone.
86+
5. You again change the moniker, this time to **SQL Server 2019**.
87+
6. You notice the 2017 section you were reading is back on display.
88+
89+
In the preceding scenario, the section about the new 2017 feature is likely marked with a _moniker range_ that includes the following moniker code:
90+
91+
- `>=sql-server-2017`
92+
93+
When the moniker **SQL Server 2019** was chosen, the versioning system realized that 2019 is greater-than-or-equal-to 2017, and it displayed the section.
94+
95+
### Scenario 2: Click a link to a hidden article
96+
97+
The following uncommon scenario explains what happens if you click a link to an article that is currently hidden from the table of contents (TOC). In brief, the link works:
98+
99+
1. The current versioning moniker is **SQL Server 2017**.
100+
2. In the current article :::no-loc text="A":::, you click a link to an article :::no-loc text="B"::: that applies only to SQL Server 2016.
101+
- Before the click, the table of contents has its entry for article :::no-loc text="B"::: hidden.
102+
3. After the click, article :::no-loc text="B"::: is displayed.
103+
- The display of article :::no-loc text="B"::: forces the versioning control to switch to the **SQL Server 2016** moniker.
104+
- Because the original moniker **SQL Server 2017** had to be abandoned. This abandoning causes an informational message to be displayed near the top of the webpage. The [message](#anchor-message-unavailable-for-moniker) explains that the current moniker had to be switched to accommodate the new article :::no-loc text="B":::.
105+
106+
### Scenario 3: Navigate to an https address
107+
108+
The following article was added new for SQL Server 2017. The article describes features that were added to SQL Server in version 2017. Most or all of those new features are also part of version 2019. Here are the attributes of the article.
109+
110+
| Attribute | Value |
111+
| :-------- | :---- |
112+
| Title | What's new in SQL Server 2017 |
113+
| moniker range | `>= sql-server-2017 || = sqlallproducts-allversions` |
114+
| `https` address | `https://docs.microsoft.com/sql/sql-server/what-s-new-in-sql-server-2017` |
115+
| &nbsp; | &nbsp; |
116+
117+
Given the base `https` address, the following table explains what happens when the `?view=` parameter is appended by the user, and with various values.
118+
119+
| Value of `?view=` | Behavior of the `https` address navigation |
120+
| :---------------- | :------------------------------ |
121+
| _(No parameter.)_ | The versioning system would try its default moniker value. Usually we set this to the latest non-Preview version of SQL Server.<br/><br/>A default of SQL Server 2017 or 2019 would satisfy the attribute `>= sql-server-2017`.<br/><br/>The system would append the parameter to the `https` address, perhaps as `?view=sql-server-2017`.<br/>The versioning drop-down list control would then be set to the match moniker name. |
122+
| `sql-server-2016` | The versioning system would realize that the moniker range of the article does not include version 2016.<br/><br/>The system would then choose one of the monikers that does satisfy the range.<br/><br/>Then as in the version 2016 case, the parameter `?view=` would be appended, and the control name would match the parameter value. |
123+
| `sql-server-2017` | The versioning system understands that the parameter value is included in the moniker range of the article.<br/><br/>The versioning control would be set to match the parameter value. |
124+
| `sql-server-2019` | Same as for the case of value `sql-server-2017`, except the parameter and control are set to 2019. |
125+
| &nbsp; | &nbsp; |
126+
127+
### <a name="anchor-allsql-hidenothing"></a> All SQL - Hide nothing, special moniker
128+
129+
There is one special moniker product name of **All SQL**, and its only version is **Hide nothing**. The purpose of this moniker is for internal testing of certain changes. If used by a customer, this moniker is more likely to mislead than to inform.
130+
131+
## <a name="anchor-message-unavailable-for-moniker"></a> Message: The requested page is not available for \<moniker\>
132+
133+
The following scenario leads to the display of an informational message near the top of the :::no-loc text="Docs"::: webpage:
134+
135+
1. Currently the versioning moniker is **SQL Server 2017**.
136+
2. You are reading an article that is relevant to SQL Server 2017.
137+
- The article is _not_ relevant to the product Azure SQL Database.
138+
3. You attempt to change the moniker to **Azure SQL Database - current**.
139+
4. You see your attempt was rejected, and a message is displayed.
140+
141+
At the end of this scenario, you see the following informational message displayed near the top of the Docs webpage:
142+
143+
> The requested page is not available for Azure SQL Database - current. You have been redirected to the newest product version this page is available for.
144+
145+
The _newest_ version might exclude versions that are not yet fully released and are in _Preview_ status.
146+
147+
![media_versioning-control-30-viewfallbackfrom.png](media/versioning-control-30-viewfallbackfrom.png)
148+
149+
## Previous versions of SQL Server
150+
151+
The versioning system is fully implemented for SQL Server version 2016 onward.
152+
153+
- _2012 and earlier:_ &nbsp; The versioning system is not used for SQL Server 2012 or earlier versions.
154+
- The special moniker of **SQL Server - older** is meant to hide almost all articles, except of couple of articles customers of older versions might need once.
155+
156+
- _2014:_ &nbsp; The versioning system is half implemented for SQL Server 2014. You can choose SQL Server 2014 in the versioning control, and it works. Yet internally the files for 2014 are dedicated to just 2014, the same way the files for 2008 are dedicated to just 2008.
157+
158+
- _2016 and later:_ &nbsp; The versioning system is fully implemented for SQL Server 2016 and later versions.
159+
160+
## See also
161+
162+
[Previous versions of SQL Server, 2014-2005](../toc/previous-versions-sql-server.md)
163+
[SQL Server docs navigation guide](sql-docs-navigation-guide.md)
164+
[How to contribute to SQL Server Documentation](sql-server-docs-contribute.md)

docs/toc.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
- name: Welcome to SQL Server
22
href: sql-server/sql-server-technical-documentation.md?toc=../toc.json
33

4-
- name: Versioning for SQL documentation
5-
href: toc/versioning-system-monikers-ui-sql-server.md
4+
- name: SQL Docs navigation tips
5+
href: sql-server/sql-docs-navigation-guide.md
66
- name: Previous versions 2014-2005
77
href: toc/previous-versions-sql-server.md
88

@@ -10461,8 +10461,8 @@
1046110461
items:
1046210462
- name: Get help
1046310463
href: sql-server/sql-server-get-help.md
10464-
- name: SQL Docs navigation tips
10465-
href: sql-server/sql-docs-navigation-guide.md
10464+
- name: Versioning for SQL documentation
10465+
href: sql-server/versioning-system-monikers-ui-sql-server.md
1046610466
- name: DBA Stack Exchange >
1046710467
href: https://dba.stackexchange.com/questions/tagged/sql-server
1046810468
- name: Stack Overflow >
-206 KB
Binary file not shown.

docs/toc/previous-versions-sql-server.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The documentation for several older versions of Microsoft SQL Server has been ar
1717
- [SQL Server previous versions documentation](/previous-versions/sql/) <!-- https://docs.microsoft.com/previous-versions/sql/ -->
1818

1919
> [!TIP]
20-
> Use the [_Version_ dropdown list control](versioning-system-monikers-ui-sql-server.md) to select the version of SQL Server you want to see documentation for. The control is available near the top of this webpage.
20+
> Use the [_Version_ dropdown list control](../sql-server/versioning-system-monikers-ui-sql-server.md) to select the version of SQL Server you want to see documentation for. The control is available near the top of this webpage.
2121
>
2222
> In the dropdown list, the value labeled **SQL Server previous versions** allows this article to be displayed. This version value also hides most other articles. Almost every other version value hides this article.
2323
>
@@ -70,4 +70,5 @@ Review the Microsoft Product Lifecycle for information about how a specific prod
7070

7171
## See also
7272

73-
[SQL Server Documentation, start](../sql-server/sql-server-technical-documentation.md?toc=../toc/toc.json&view=sql-server-2017)
73+
[SQL Server Documentation, start](../sql-server/sql-server-technical-documentation.md?view=sql-server-2016)
74+
[Versioning system for SQL documentation](../sql-server/versioning-system-monikers-ui-sql-server.md?view=sql-server-2016)

0 commit comments

Comments
 (0)