System przechowywania wersji dokumentacji SQL

Dotyczy:programu SQL ServerAzure SQL DatabaseAzure Synapse Analytics

W tym artykule wyjaśniono nasz system przechowywania wersji dla dokumentacji sql. System przechowywania wersji wie o produktach i ich wersjach. System umożliwia wybranie interesującego Cię produktu i wersji. Następnie system wyświetla odpowiednią dokumentację.

Dotyczy produktów

Większość artykułów o SQL Server zawiera pod tytułem słowa Dotyczy: W tym samym wierszu znajduje się przydatna lista produktów SQL ze wskaźnikami, czy artykuł jest odpowiedni dla produktu. Na przykład produkt SQL Server może być wskazany jako odpowiedni, podczas gdy usługa Azure SQL Database może być wskazana jako nieistotna dla artykułu.

Wiersz Dotyczy nie uwzględnia wersji produktów. Staramy się unikać rozbieżności między wierszem Dotyczy a częścią dotyczącą produktów w konfiguracjach naszego systemu wersjonowania.

Historia oddzielnych zestawów plików

W przypadku programu SQL Server 2014 i starszych wersji każda wersja ma własną pełną kopię plików dokumentacji. Na przykład dokumentacja programu SQL Server 2014 rozpoczęła się jako kopia dokumentacji programu SQL Server 2012. Kopia z 2014 r. została następnie edytowana podczas cyklu tworzenia produktu.

To stare podejście oznaczało, że jeśli w dokumentacji z 2014 r. wykryto wadę, w 2012 i 2008 r. może istnieć również wada. To sprawiło, że naprawienie wad i ogólnej konserwacji było trudniejsze.

Wiele wersji w tych samych plikach

Z tego powodu i inne pliki dokumentacji programu SQL Server 2016 są również przeznaczone dla wersji 2017, 2019 i prawdopodobnie dla programu <vNext>. Ta konsolidacja jest możliwa w praktyce, ponieważ teraz przypisujemy identyfikatory wersji do plików dokumentacji SQL Server. Monikery wersji są przypisywane lub jawnie osadzane na takim poziomie szczegółowości, jaki ma sens dla każdego pliku dokumentacji.

Kontrola wersji w interfejsie użytkownika

Gdy wyświetlasz dowolny artykuł dokumentacji SQL w naszej witrynie Docs, aktualnie wybrane oznaczenie wersji jest widoczne nad spisem treści (TOC). Kontrolka jest listą rozwijaną.

media_versioning-control-10-sql-server-2017.png

Jeśli chcesz wyświetlić dokumentację dla innej wersji programu SQL Server, wybierz strzałkę rozwijania znajdującą się na końcu bieżącego pseudonimu wersji. Następnie wybierz dowolną kombinację produktu i wersji. Po wybraniu innej wersji wyświetlana dokumentacja nagle zmieni się, aby pokazać różnice dla nowo wybranej wersji. Mogą wystąpić zmiany, ale nie muszą, a obie sytuacje są powszechne.

media_versioning-control-20-expanded.png

Parametr HTTPS view=

Każdy artykuł, którego adres internetowy zaczyna się od https://learn.microsoft.com/sql/ , ma parametr o nazwie ?view= dołączany do jego adresu. Ta wartość parametru to kod identyfikatora wersji.

Moniker code w adresie https zawsze odpowiada monikerowi name wyświetlanemu w mechanizmie kontroli wersji.

Produkty, a nie wersje

Edycje

W 1990 roku i w 2000 roku program Microsoft SQL Server miał tylko jeden produkt. W każdej wersji programu SQL Server były różne wersje , takie jak wersje Developer i Enterprise programu SQL Server 2008. Wersje reprezentowały nieco inne zestawy funkcji, ale podstawowy produkt był taki sam. Nowe wersje programu SQL Server mogą nadal mieć różne wersje.

Products

Wraz z najnowszym wzrostem przetwarzania w chmurze i platformy Microsoft Azure firma Microsoft wydała swój produkt Azure SQL Database. Chociaż istnieje wiele kodu współużytkowanego zarówno przez tradycyjny produkt lokalny programu SQL Server, jak i produkt usługi Azure SQL Database, te produkty są dwoma naprawdę oddzielnymi produktami.

W przypadku SQL identyfikatory wersji pozwalają rozróżniać produkty, ale nie edycje.

Produkty Sql w chmurze platformy Azure

W przypadku artykułów całych adresów internetowych zaczyna się od https://learn.microsoft.com/sql/, prawie wszystkie dotyczą co najmniej jednej wersji produktu o nazwie SQL Server. Duży podzbiór tych artykułów dotyczy również co najmniej jednego produktu usługi SQL hostowanego w chmurze platformy Azure. Jeden z takich produktów w chmurze SQL nosi nazwę Azure SQL Database.

Oczywiście produkt usługi Azure SQL Database ma tylko jedną wersję. Prawie wszystkie artykuły dotyczące usługi Azure SQL Database, ale nie do programu SQL Server, mają adresy internetowe rozpoczynające się od https://learn.microsoft.com/azure/sql-database/.

Scenariusze filtrowania wersji

System przechowywania wersji działa przez odfiltrowanie całej zawartości dokumentacji, która nie ma zastosowania do aktualnie aktywnego pseudonimu. Za każdym razem, gdy wybierzesz inny identyfikator wersji, zmienia się zestaw ukrytej zawartości. Filtrowanie ukrywa zawartość na następujących poziomach:

  • Sekcje lub zdania w artykule.
  • Wpisy artykułów w spisie treści (SPIS TREŚCI).

Poniżej przedstawiono scenariusze, które wyjaśniają skutki wyboru innego pseudonimu.

Scenariusz 1: W bieżącym artykule

Poniższy scenariusz koncentruje się na sekcjach w bieżącym artykule:

  1. Bieżące oznaczenie wersji to SQL Server 2017.
  2. Czytasz sekcję opisjącą funkcję, która została po raz pierwszy dodana do wersji 2017 programu SQL Server.
  3. Zmień nazwę na SQL Server 2016.
  4. Zauważysz, że sekcja, którą czytałeś, zniknęła.
  5. Ponownie zmienisz nazwę , tym razem na SQL Server 2019.
  6. Zauważysz, że przeczytana sekcja z 2017 r. jest ponownie wyświetlana.

W poprzednim scenariuszu sekcja dotycząca nowej funkcji z 2017 roku jest prawdopodobnie oznaczona zakresem monikera, który obejmuje następujący kod monikera:

  • >=sql-server-2017

Po wybraniu nazwy programu SQL Server 2019 system przechowywania wersji zdał sobie sprawę, że 2019 r. jest większy niż lub równy 2017 r. i wyświetlił sekcję.

Scenariusz 2. Wybieranie linku do ukrytego artykułu

Poniższy nietypowy scenariusz wyjaśnia, co się stanie po wybraniu łącza do artykułu, który jest obecnie ukryty w spisie treści (TOC). W skrócie link działa:

  1. Bieżące oznaczenie wersji to SQL Server 2017.
  2. W bieżącym artykule Awybierz link do artykułu B , który dotyczy tylko programu SQL Server 2016.
    • Przed wybraniem spis treści ma ukryty wpis dla artykułu B.
  3. Po zaznaczeniu zostanie wyświetlony artykuł B .
    • Wyświetlenie artykułu B wymusza przełączenie mechanizmu wersjonowania na moniker SQL Server 2016.
    • Ponieważ oryginalna nazwa SQL Server 2017 musiała zostać porzucona. Przerwanie tej czynności powoduje wyświetlenie komunikatu informacyjnego u góry strony internetowej. Komunikat wyjaśnia, że bieżący pseudonim musiał zostać przełączony, aby uwzględnić nowy artykuł B.

Scenariusz 3. Przechodzenie do adresu HTTPS

W programie SQL Server 2017 dodano nowy artykuł. W tym artykule opisano funkcje dodane do programu SQL Server w wersji 2017. Większość lub wszystkie te nowe funkcje są również częścią wersji 2019. Oto atrybuty artykułu.

Attribute Wartość
Title Co nowego w programie SQL Server 2017
zakres moniker =">= sql-server-2017"
https adres https://learn.microsoft.com/sql/sql-server/what-s-new-in-sql-server-2017

Biorąc pod uwagę adres podstawowy https , w poniższej tabeli wyjaśniono, co się stanie, gdy ?view= parametr jest dołączany przez użytkownika i z różnymi wartościami.

Wartość ?view= Działanie nawigacji adresu https
(Brak parametru) System wersjonowania spróbuje użyć domyślnej wartości identyfikatora. Zazwyczaj ustawiamy tę opcję na najnowszą wersję spoza wersji zapoznawczej programu SQL Server.

Wartość domyślna programu SQL Server 2017 lub 2019 spełnia atrybut >= sql-server-2017.

System dołączy parametr do https adresu, być może jako ?view=sql-server-2017.
Kontrolka listy rozwijanej wersjonowania zostałaby następnie ustawiona na nazwę pasującego identyfikatora.
sql-server-2016 System przechowywania wersji zda sobie sprawę, że zakres moniker artykułu nie zawiera wersji 2016.

Następnie system wybrałby jedną z nazw, która mieści się w danym zakresie.

Następnie, podobnie jak w przypadku wersji 2016, parametr ?view= zostanie dołączony, a nazwa kontrolki będzie zgodna z wartością parametru.
sql-server-2017 System wersjonowania uwzględnia, że wartość parametru mieści się w zakresie monikerów artykułu.

Kontrolka przechowywania wersji zostanie ustawiona tak, aby odpowiadała wartości parametru.
sql-server-2019 Tak jak w przypadku wartości sql-server-2017, z wyjątkiem tego, że parametr i kontrolka są ustawione na 2019.

Wszystkie SQL — nic nie ukrywaj, specjalny pseudonim

Jest jedna specjalna nazwa produktu: All SQL, a jego jedyną wersją jest Hide nothing. Celem tego pseudonimu jest wewnętrzne testowanie niektórych zmian. Jeśli klient używa tego określenia, prędzej wprowadzi ono w błąd, niż poinformuje.

Niektóre artykuły zawierają informacje dotyczące wielu wersji programu SQL Server. Każdy standardowy moniker ukrywa sekcje wersjonowane, które w przeciwnym razie wyświetlałyby informacje niedokładne, mylące lub sprzeczne dla wersji danego monikera. Specjalny moniker All SQL wyświetla wszystkie sekcje wersji i może nie być oczywiste, że wyświetlane są niedokładne informacje.

Komunikat: Żądana strona nie jest dostępna dla moniker <>

Poniższy scenariusz prowadzi do wyświetlenia komunikatu informacyjnego w górnej Docs części strony internetowej:

  1. Obecnie oznaczenie wersji to SQL Server 2017.
  2. Czytasz artykuł dotyczący programu SQL Server 2017.
    • Artykuł nie jest istotny dla produktu Azure SQL Database.
  3. Próbujesz zmienić moniker na Azure SQL Database — bieżący.
  4. Zobaczysz, że próba została odrzucona, a zostanie wyświetlony komunikat.

Na końcu tego scenariusza zostanie wyświetlony następujący komunikat informacyjny w górnej części strony internetowej witryny Docs:

Żądana strona nie jest dostępna dla usługi Azure SQL Database — wersja bieżąca. Przekierowano Cię do najnowszej wersji produktu, dla której ta strona jest dostępna.

Najnowsza wersja może wykluczać wersje, które nie zostały jeszcze w pełni wydane i mają stan wersji zapoznawczej.

media_versioning-control-30-viewfallbackfrom.png

Poprzednie wersje programu SQL Server

System przechowywania wersji jest w pełni zaimplementowany dla programu SQL Server w wersji 2016.