Skip to content

Commit 88b692d

Browse files
BenjinBenjin
authored
Adding VS Code walkthroughs (#18694)
* adding walkthroughs * formatted * adding query sort/filter * loc update * updated pictures for Getting Started walkthrough * Adding images for Next Steps * loc * fixing json formatting * fixing merge * fixing whitespace * whitespace * reverting more whitespace * whitespace * nls whitespace * swapping for const * Fixing typo in package.json and adding missing string in nls.json * loc * Scaling screenshots down * fixing casing * xlf update
1 parent 9418ddf commit 88b692d

12 files changed

+239
-13
lines changed

‎images/walkthroughs/connectToDatabase.png

90 KB
Loading

‎images/walkthroughs/createNewTable.png

160 KB
Loading

‎images/walkthroughs/enableModernFeatures.png

54 KB
Loading

‎images/walkthroughs/objectExplorerFilters.png

101 KB
Loading

‎images/walkthroughs/runQueries.png

156 KB
Loading

‎images/walkthroughs/sortAndFilterQueryResults.png

149 KB
Loading

‎images/walkthroughs/viewQueryPlan.png

109 KB
Loading

‎localization/xliff/vscode-mssql.xlf

+78
Original file line numberDiff line numberDiff line change
@@ -1593,6 +1593,12 @@
15931593
<trans-unit id="mssql.connect">
15941594
<source xml:lang="en">Connect</source>
15951595
</trans-unit>
1596+
<trans-unit id="mssql.walkthroughs.getStarted.connectToDatabase.title">
1597+
<source xml:lang="en">Connect to a SQL Database</source>
1598+
</trans-unit>
1599+
<trans-unit id="mssql.walkthroughs.getStarted.connectToDatabase.altText">
1600+
<source xml:lang="en">Connection Dialog</source>
1601+
</trans-unit>
15961602
<trans-unit id="mssql.connections">
15971603
<source xml:lang="en">Connection profiles defined in &apos;User Settings&apos; are shown under &apos;MS SQL: Connect&apos; command in the command palette.</source>
15981604
</trans-unit>
@@ -1608,6 +1614,12 @@
16081614
<trans-unit id="mssql.createAzureFunction">
16091615
<source xml:lang="en">Create Azure Function with SQL binding</source>
16101616
</trans-unit>
1617+
<trans-unit id="mssql.walkthroughs.getStarted.createNewTable.title">
1618+
<source xml:lang="en">Create a Table with Table Designer</source>
1619+
</trans-unit>
1620+
<trans-unit id="mssql.walkthroughs.getStarted.createNewTable.description">
1621+
<source xml:lang="en">Create a new table in your database, or edit existing tables with the table designer.&#10;Once you&apos;re done making your changes, click the &apos;Publish&apos; button to send the changes to your database.</source>
1622+
</trans-unit>
16111623
<trans-unit id="mssql.deleteQueryHistory">
16121624
<source xml:lang="en">Delete</source>
16131625
</trans-unit>
@@ -1638,6 +1650,12 @@
16381650
<trans-unit id="mssql.objectExplorer.enableGroupBySchema">
16391651
<source xml:lang="en">Enable Group By Schema</source>
16401652
</trans-unit>
1653+
<trans-unit id="mssql.walkthroughs.getStarted.enableModernFeatures.title">
1654+
<source xml:lang="en">Enable Modern Features</source>
1655+
</trans-unit>
1656+
<trans-unit id="mssql.enableRichExperiences">
1657+
<source xml:lang="en">Enable Modern Features</source>
1658+
</trans-unit>
16411659
<trans-unit id="mssql.query.alwaysEncryptedParameterization">
16421660
<source xml:lang="en">Enable Parameterization for Always Encrypted</source>
16431661
</trans-unit>
@@ -1701,6 +1719,12 @@
17011719
<trans-unit id="mssql.query.xactAbortOn">
17021720
<source xml:lang="en">Enable SET XACT_ABORT ON option</source>
17031721
</trans-unit>
1722+
<trans-unit id="mssql.walkthroughs.getStarted.enableModernFeatures.altText">
1723+
<source xml:lang="en">Enable modern features in MSSQL</source>
1724+
</trans-unit>
1725+
<trans-unit id="mssql.walkthroughs.getStarted.enableModernFeatures.description">
1726+
<source xml:lang="en">Enable the new set of data development features that provide a modern way to work with your SQL database in VS Code.&#10;[Enable New Experiences](command:mssql.enableRichExperiences)</source>
1727+
</trans-unit>
17041728
<trans-unit id="mssql.enableRichExperiences.description">
17051729
<source xml:lang="en">Enables UI-based features in the MSSQL extension for richer and more powerful features. Restart Visual Studio Code after changing this setting.</source>
17061730
</trans-unit>
@@ -1725,9 +1749,18 @@
17251749
<trans-unit id="mssql.runQuery">
17261750
<source xml:lang="en">Execute Query</source>
17271751
</trans-unit>
1752+
<trans-unit id="mssql.walkthroughs.nextSteps.description">
1753+
<source xml:lang="en">Familiarize yourself with more features of the MSSQL extension that can help you be more productive.</source>
1754+
</trans-unit>
17281755
<trans-unit id="mssql.filterNode">
17291756
<source xml:lang="en">Filter (Preview)</source>
17301757
</trans-unit>
1758+
<trans-unit id="mssql.walkthroughs.nextSteps.objectExplorerFilters.title">
1759+
<source xml:lang="en">Filter your Object Explorer Tree</source>
1760+
</trans-unit>
1761+
<trans-unit id="mssql.walkthroughs.getStarted.title">
1762+
<source xml:lang="en">Get Started with MSSQL for Visual Studio Code</source>
1763+
</trans-unit>
17311764
<trans-unit id="mssql.showGettingStarted">
17321765
<source xml:lang="en">Getting Started Guide</source>
17331766
</trans-unit>
@@ -1737,6 +1770,9 @@
17371770
<trans-unit id="mssql.Configuration">
17381771
<source xml:lang="en">MSSQL configuration</source>
17391772
</trans-unit>
1773+
<trans-unit id="mssql.walkthroughs.getStarted.connectToDatabase.description">
1774+
<source xml:lang="en">Make a new connection to a SQL database, or edit existing connections with the connection dialog.&#10;You can connect to a database by entering your connection information, using a connection string, or browsing your Azure subscriptions.&#10;[Open Connection Dialog](command:mssql.addObjectExplorer)</source>
1775+
</trans-unit>
17401776
<trans-unit id="mssql.manageProfiles">
17411777
<source xml:lang="en">Manage Connection Profiles</source>
17421778
</trans-unit>
@@ -1764,12 +1800,21 @@
17641800
<trans-unit id="mssql.newTable">
17651801
<source xml:lang="en">New Table</source>
17661802
</trans-unit>
1803+
<trans-unit id="mssql.walkthroughs.nextSteps.title">
1804+
<source xml:lang="en">Next Steps with MSSQL for Visual Studio Code</source>
1805+
</trans-unit>
17671806
<trans-unit id="mssql.logRetentionMinutes">
17681807
<source xml:lang="en">Number of minutes to retain log files for backend services. Default is 1 week.</source>
17691808
</trans-unit>
17701809
<trans-unit id="mssql.queryHistoryLimit">
17711810
<source xml:lang="en">Number of query history entries to show in the Query History view</source>
17721811
</trans-unit>
1812+
<trans-unit id="mssql.walkthroughs.nextSteps.objectExplorerFilters.altText">
1813+
<source xml:lang="en">Object Explorer filters</source>
1814+
</trans-unit>
1815+
<trans-unit id="mssql.walkthroughs.nextSteps.objectExplorerFilters.description">
1816+
<source xml:lang="en">Only see the database objects that matter most to you by applying filters to the Object Explorer tree.&#10;Start by clicking the filter button next to most folders in the Connections view.</source>
1817+
</trans-unit>
17731818
<trans-unit id="mssql.openExecutionPlanFile">
17741819
<source xml:lang="en">Open Execution Plan File</source>
17751820
</trans-unit>
@@ -1791,6 +1836,12 @@
17911836
<trans-unit id="extension.queryResult">
17921837
<source xml:lang="en">Query Results (Preview)</source>
17931838
</trans-unit>
1839+
<trans-unit id="mssql.walkthroughs.getStarted.runQueries.altText">
1840+
<source xml:lang="en">Query editor and query results pane</source>
1841+
</trans-unit>
1842+
<trans-unit id="mssql.walkthroughs.nextSteps.viewQueryPlan.altText">
1843+
<source xml:lang="en">Query plan visualization</source>
1844+
</trans-unit>
17941845
<trans-unit id="mssql.refreshObjectExplorerNode">
17951846
<source xml:lang="en">Refresh</source>
17961847
</trans-unit>
@@ -1809,6 +1860,9 @@
18091860
<trans-unit id="mssql.runQueryHistory">
18101861
<source xml:lang="en">Run Query</source>
18111862
</trans-unit>
1863+
<trans-unit id="mssql.walkthroughs.getStarted.runQueries.title">
1864+
<source xml:lang="en">Run a SQL Query</source>
1865+
</trans-unit>
18121866
<trans-unit id="mssql.schemaCompare">
18131867
<source xml:lang="en">Schema Compare (Preview)</source>
18141868
</trans-unit>
@@ -1881,9 +1935,21 @@
18811935
<trans-unit id="mssql.format.placeSelectStatementReferencesOnNewLine">
18821936
<source xml:lang="en">Should references to objects in a select statements be split into separate lines? E.g. for &apos;SELECT C1, C2 FROM T1&apos; both C1 and C2 will be on separate lines</source>
18831937
</trans-unit>
1938+
<trans-unit id="mssql.walkthroughs.nextSteps.sortAndFilterQueryResults.title">
1939+
<source xml:lang="en">Sort and Filter Query Results</source>
1940+
</trans-unit>
1941+
<trans-unit id="mssql.walkthroughs.nextSteps.sortAndFilterQueryResults.altText">
1942+
<source xml:lang="en">Sort and filter options for query results</source>
1943+
</trans-unit>
1944+
<trans-unit id="mssql.walkthroughs.nextSteps.sortAndFilterQueryResults.description">
1945+
<source xml:lang="en">Sort and filter your query results to find the data you need quickly.</source>
1946+
</trans-unit>
18841947
<trans-unit id="mssql.startQueryHistoryCapture">
18851948
<source xml:lang="en">Start Query History Capture</source>
18861949
</trans-unit>
1950+
<trans-unit id="mssql.walkthroughs.getStarted.createNewTable.altText">
1951+
<source xml:lang="en">Table Designer</source>
1952+
</trans-unit>
18871953
<trans-unit id="mssql.maxRecentConnections">
18881954
<source xml:lang="en">The maximum number of recently used connections to store in the connection list.</source>
18891955
</trans-unit>
@@ -1896,15 +1962,27 @@
18961962
<trans-unit id="mssql.messagesDefaultOpen">
18971963
<source xml:lang="en">True for the messages pane to be open by default; false for closed</source>
18981964
</trans-unit>
1965+
<trans-unit id="mssql.walkthroughs.nextSteps.viewQueryPlan.description">
1966+
<source xml:lang="en">Understand what your query is doing by viewing the query plan.&#10;See the estimated plan without running the query, or view the actual query plan after running the query by toggling the buttons at the top of a query editor window.</source>
1967+
</trans-unit>
18991968
<trans-unit id="mssql.chooseDatabase">
19001969
<source xml:lang="en">Use Database</source>
19011970
</trans-unit>
19021971
<trans-unit id="mssql.visualizeSchema">
19031972
<source xml:lang="en">Visualize Schema</source>
19041973
</trans-unit>
1974+
<trans-unit id="mssql.walkthroughs.nextSteps.viewQueryPlan.title">
1975+
<source xml:lang="en">Visualize a Query Plan</source>
1976+
</trans-unit>
19051977
<trans-unit id="mssql.objectExplorer.groupBySchema">
19061978
<source xml:lang="en">When enabled, the database objects in Object Explorer will be categorized by schema.</source>
19071979
</trans-unit>
1980+
<trans-unit id="mssql.walkthroughs.getStarted.runQueries.description">
1981+
<source xml:lang="en">Write a SQL query, and run it against your database.&#10;You can also click the &apos;Open in New Tab&apos; button to view your query results in their own tab, and optionally set that as the default behavior.</source>
1982+
</trans-unit>
1983+
<trans-unit id="mssql.walkthroughs.getStarted.description">
1984+
<source xml:lang="en">Your first steps for connecting to and developing with a SQL database</source>
1985+
</trans-unit>
19081986
<trans-unit id="mssql.saveAsCsv.textIdentifier">
19091987
<source xml:lang="en">[Optional] Character used for enclosing text fields when saving results as CSV</source>
19101988
</trans-unit>

‎package.json

+113-2
Original file line numberDiff line numberDiff line change
@@ -921,6 +921,11 @@
921921
"dark": "media/disableActualExecutionPlan_dark.svg",
922922
"light": "media/disableActualExecutionPlan_light.svg"
923923
}
924+
},
925+
{
926+
"command": "mssql.enableRichExperiences",
927+
"title": "%mssql.enableRichExperiences%",
928+
"category": "MS SQL"
924929
}
925930
],
926931
"keybindings": [
@@ -1474,7 +1479,10 @@
14741479
"description": "%mssql.query.maxXmlCharsToStore%"
14751480
},
14761481
"mssql.autoDisableNonTSqlLanguageService": {
1477-
"type": ["boolean", "null"],
1482+
"type": [
1483+
"boolean",
1484+
"null"
1485+
],
14781486
"default": null,
14791487
"description": "%mssql.autoDisableNonTSqlLanguageService%"
14801488
},
@@ -1624,6 +1632,109 @@
16241632
"description": "%mssql.objectExplorer.expandTimeout%"
16251633
}
16261634
}
1627-
}
1635+
},
1636+
"walkthroughs": [
1637+
{
1638+
"id": "mssql.getStarted",
1639+
"title": "%mssql.walkthroughs.getStarted.title%",
1640+
"description": "%mssql.walkthroughs.getStarted.description%",
1641+
"steps": [
1642+
{
1643+
"id": "enableModernFeatures",
1644+
"title": "%mssql.walkthroughs.getStarted.enableModernFeatures.title%",
1645+
"description": "%mssql.walkthroughs.getStarted.enableModernFeatures.description%",
1646+
"media": {
1647+
"image": "images/walkthroughs/enableModernFeatures.png",
1648+
"altText": "%mssql.walkthroughs.getStarted.enableModernFeatures.altText%"
1649+
},
1650+
"completionEvents": [
1651+
"onCommand:mssql.enableRichExperiences",
1652+
"config.mssql.enableRichExperiences == true"
1653+
]
1654+
},
1655+
{
1656+
"id": "connectToDatabase",
1657+
"title": "%mssql.walkthroughs.getStarted.connectToDatabase.title%",
1658+
"description": "%mssql.walkthroughs.getStarted.connectToDatabase.description%",
1659+
"media": {
1660+
"image": "images/walkthroughs/connectToDatabase.png",
1661+
"altText": "%mssql.walkthroughs.getStarted.connectToDatabase.altText%"
1662+
},
1663+
"completionEvents": [
1664+
"onCommand:mssql.addObjectExplorer"
1665+
]
1666+
},
1667+
{
1668+
"id": "createNewTable",
1669+
"title": "%mssql.walkthroughs.getStarted.createNewTable.title%",
1670+
"description": "%mssql.walkthroughs.getStarted.createNewTable.description%",
1671+
"media": {
1672+
"image": "images/walkthroughs/createNewTable.png",
1673+
"altText": "%mssql.walkthroughs.getStarted.createNewTable.altText%"
1674+
},
1675+
"completionEvents": [
1676+
"onCommand:mssql.newTable",
1677+
"onCommand:mssql.editTable"
1678+
]
1679+
},
1680+
{
1681+
"id": "runQueries",
1682+
"title": "%mssql.walkthroughs.getStarted.runQueries.title%",
1683+
"description": "%mssql.walkthroughs.getStarted.runQueries.description%",
1684+
"media": {
1685+
"image": "images/walkthroughs/runQueries.png",
1686+
"altText": "%mssql.walkthroughs.getStarted.runQueries.altText%"
1687+
},
1688+
"completionEvents": [
1689+
"onCommand:mssql.runQuery"
1690+
]
1691+
}
1692+
]
1693+
},
1694+
{
1695+
"id": "mssql.nextSteps",
1696+
"title": "%mssql.walkthroughs.nextSteps.title%",
1697+
"description": "%mssql.walkthroughs.nextSteps.description%",
1698+
"steps": [
1699+
{
1700+
"id": "sortAndFilterQueryResults",
1701+
"title": "%mssql.walkthroughs.nextSteps.sortAndFilterQueryResults.title%",
1702+
"description": "%mssql.walkthroughs.nextSteps.sortAndFilterQueryResults.description%",
1703+
"media": {
1704+
"image": "images/walkthroughs/sortAndFilterQueryResults.png",
1705+
"altText": "%mssql.walkthroughs.nextSteps.sortAndFilterQueryResults.altText%"
1706+
},
1707+
"completionEvents": []
1708+
},
1709+
{
1710+
"id": "viewQueryPlan",
1711+
"title": "%mssql.walkthroughs.nextSteps.viewQueryPlan.title%",
1712+
"description": "%mssql.walkthroughs.nextSteps.viewQueryPlan.description%",
1713+
"media": {
1714+
"image": "images/walkthroughs/viewQueryPlan.png",
1715+
"altText": "%mssql.walkthroughs.nextSteps.viewQueryPlan.altText%"
1716+
},
1717+
"completionEvents": [
1718+
"onCommand:mssql.showExecutionPlanInResults",
1719+
"onCommand:mssql.enableActualPlan",
1720+
"onCommand:mssql.disableActualPlan"
1721+
]
1722+
},
1723+
{
1724+
"id": "objectExplorerFilters",
1725+
"title": "%mssql.walkthroughs.nextSteps.objectExplorerFilters.title%",
1726+
"description": "%mssql.walkthroughs.nextSteps.objectExplorerFilters.description%",
1727+
"media": {
1728+
"image": "images/walkthroughs/objectExplorerFilters.png",
1729+
"altText": "%mssql.walkthroughs.nextSteps.objectExplorerFilters.altText%"
1730+
},
1731+
"completionEvents": [
1732+
"onCommand:mssql.filterNodeWithExistingFilters",
1733+
"onCommand:mssql.filterNode"
1734+
]
1735+
}
1736+
]
1737+
}
1738+
]
16281739
}
16291740
}

0 commit comments

Comments
 (0)