Update walkthrough (#1792)

mattseddon · web-flow · commit c54dd76f9ae1 · 2022-05-30T22:44:23.000Z
* update walkthrough text

* consolidate terminology for accessing the command palette

* capitalise community
diff --git a/README.md b/README.md
@@ -26,7 +26,7 @@ After we conclude alpha and beta testing the repository will become public.
 - **Step 3.** See walkthrough.
 
 **Note:** You will be prompted to open our walkthrough after installation. If
-for any reason you need to revisit the walkthrough, open the command palette
+for any reason you need to revisit the walkthrough, open the Command Palette
 (⇧⌃P on Windows/Linux or ⇧⌘P on macOS) and select the `DVC: Get Started`
 command.
 
diff --git a/extension/package.json b/extension/package.json
@@ -1306,7 +1306,7 @@
           {
             "id": "dvc.installDVC",
             "title": "Install DVC",
-            "description": "The DVC Extension requires DVC to be installed. To install follow the guide shown on [dvc.org](https://dvc.org).\n\n[Install DVC](https://dvc.org/doc/install)\n",
+            "description": "The DVC extension requires DVC to be installed. To install follow the guide shown on [dvc.org](https://dvc.org).\n\n[Install DVC](https://dvc.org/doc/install)\n",
             "media": {
               "markdown": "resources/walkthrough/install-dvc.md"
             },
@@ -1318,7 +1318,7 @@
           {
             "id": "dvc.setup",
             "title": "Setup The Workspace",
-            "description": "Setup the workspace for the dvc extension.\n[Setup The Workspace](command:dvc.setupWorkspace)",
+            "description": "Setup the workspace for the DVC extension.\n[Setup The Workspace](command:dvc.setupWorkspace)",
             "media": {
               "markdown": "resources/walkthrough/setup-workspace.md"
             },
@@ -1329,7 +1329,7 @@
           {
             "id": "dvc.showCommands",
             "title": "Available Commands",
-            "description": "View all of the available commands.\n[View Commands](command:dvc.showCommands)",
+            "description": "View available commands.\n[View Commands](command:dvc.showCommands)",
             "media": {
               "markdown": "resources/walkthrough/command-palette.md"
             },
@@ -1353,7 +1353,7 @@
           {
             "id": "dvc.scm",
             "title": "Source Control Management",
-            "description": "Open the DVC SCM view.\n[Show SCM](command:workbench.view.scm)",
+            "description": "Open the SCM view.\n[Show SCM](command:workbench.view.scm)",
             "media": {
               "markdown": "resources/walkthrough/source-control-management.md"
             },
diff --git a/extension/resources/walkthrough/command-palette.md b/extension/resources/walkthrough/command-palette.md
@@ -1,10 +1,11 @@
-# Command palette
+# Command Palette
 
 This extension makes extensive use of the
 [Command Palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette).
+Which can be accessed via ⇧⌃P on Windows/Linux or ⇧⌘P on macOS.
 
-To see a list of available commands
-[type DVC into the command palette](command:dvc.showCommands).
+To see a list of available commands click [here](command:dvc.showCommands) or
+type DVC into the Command Palette.
 
 For further information on `DVC` commands see the
 [command-reference docs](https://dvc.org/doc/command-reference).
diff --git a/extension/resources/walkthrough/dvc-learn-more.md b/extension/resources/walkthrough/dvc-learn-more.md
@@ -1,4 +1,4 @@
-# DVC CLI - Resources
+# More Resources
 
 - Get started with our [guide](https://dvc.org/doc/start).
 
@@ -11,6 +11,8 @@
 - Check out the [DVC github repository](https://github.com/iterative/dvc) or an
   [example project](https://github.com/iterative/example-get-started).
 
+- Explore our [free course](https://learn.iterative.ai/).
+
 - Read our [blog](https://dvc.org/blog).
 
-- Meet the [community](https://dvc.org/community).
+- Meet the [Community](https://dvc.org/community).
diff --git a/extension/resources/walkthrough/experiments-table.md b/extension/resources/walkthrough/experiments-table.md
@@ -1,6 +1,9 @@
-# Experiments table
+# Experiments Table
 
 The extension's equivalent of `dvc exp show`.
 
-Use `DVC: Show Experiments` from the command palette to open up the experiments
+Use `DVC: Show Experiments` from the Command Palette to open up the experiments
 table for a `DVC` repository.
+
+The view can be manipulated using the controls shown in the extension's view
+container.
diff --git a/extension/resources/walkthrough/install-dvc.md b/extension/resources/walkthrough/install-dvc.md
@@ -8,5 +8,6 @@ To install the latest version of `DVC` follow your platform specific guide on
 
 To verify the installation run `dvc -h` in your terminal of choice.
 
-**Note**: you can create a new integrated terminal from the command palette. Run
-`Terminal: Create New Terminal`.
+**Note**: Use `Terminal: Create New Terminal` from the Command Palette to create
+a new
+[integrated terminal](https://code.visualstudio.com/docs/editor/integrated-terminal).
diff --git a/extension/resources/walkthrough/output-channel.md b/extension/resources/walkthrough/output-channel.md
@@ -1,4 +1,4 @@
-# Output channel
+# Output Channel
 
 All `DVC` CLI commands generate two entries in this extension's dedicated output
 channel.
diff --git a/extension/resources/walkthrough/plots.md b/extension/resources/walkthrough/plots.md
@@ -7,5 +7,8 @@ The extension will display the following sections for selected experiments:
 - Images - a table used to display image plots side by side.
 - Trends - linear plots based on data from the experiments table.
 
-Use `DVC: Show Plots` from the command palette to open the view for a `DVC`
+Use `DVC: Show Plots` from the Command Palette to open the view for a `DVC`
 repository.
+
+The view can be manipulated using the controls shown in the extension's view
+container.
diff --git a/extension/resources/walkthrough/setup-workspace.md b/extension/resources/walkthrough/setup-workspace.md
@@ -7,9 +7,9 @@ You will need a `DVC` project opened within the workspace to see all of the
 extension's available features. See the `Explore More Resources` step for
 details on creating a `DVC` project.
 
-Use the workspace setup wizard to set the required config options. See the
-welcome view underneath the `DVC Tracked` view in the side bar's explorer view
-container or [DVC: Setup The Workspace](command:dvc.setupWorkspace) from the
-command palette.
+Use the workspace setup wizard to set the required config options.
 
 Once completed, the rest of the walkthrough will appear.
+
+The wizard can be accessed by clicking [here](command:dvc.setupWorkspace) or use
+`DVC: Setup The Workspace` from the Command Palette.
diff --git a/extension/resources/walkthrough/source-control-management.md b/extension/resources/walkthrough/source-control-management.md
@@ -1,4 +1,4 @@
-# Source control management
+# Source Control Management
 
 Resources tracked by `DVC` can be managed through the SCM view.
 
diff --git a/extension/resources/walkthrough/tracked-explorer.md b/extension/resources/walkthrough/tracked-explorer.md
@@ -1,4 +1,4 @@
-# Tracked resources
+# Tracked Resources
 
 Resources tracked by `DVC` can be viewed and managed via the tracked explorer
 view.
diff --git a/extension/resources/walkthrough/view-container.md b/extension/resources/walkthrough/view-container.md
@@ -1,8 +1,14 @@
-# DVC view container
+# DVC View Container
 
 The view container provides supplementary information and control over the
 experiments and plots in the workspace.
 
-The container can be accessed by clicking on the `DVC` icon in the activity bar
-or running [View: Show DVC](command:workbench.view.extension.dvc-views) from the
-command palette.
+Click on the `DVC` icon in the
+[Activity Bar](https://code.visualstudio.com/docs/getstarted/userinterface) to
+access the container or use
+[View: Show DVC](command:workbench.view.extension.dvc-views) from the Command
+Palette.
+
+A welcome view showing some getting started instructions will appear in the
+container when the CLI is not accessible or if there is not a `DVC` project
+available in the workspace.
diff --git a/extension/src/test/suite/repository/workspace.test.ts b/extension/src/test/suite/repository/workspace.test.ts
@@ -25,7 +25,7 @@ suite('Workspace Repositories Test Suite', () => {
   })
 
   describe('WorkspaceRepositories', () => {
-    it('should be able to run commit from the command palette with multiple roots in the workspace', async () => {
+    it('should be able to run commit from the Command Palette with multiple roots in the workspace', async () => {
       const mockCommit = stub(CliExecutor.prototype, 'commit').resolves('')
       const executeCommandSpy = spy(commands, 'executeCommand')
 
@@ -54,7 +54,7 @@ suite('Workspace Repositories Test Suite', () => {
       ).to.be.calledWith('workbench.scm.focus')
     })
 
-    it('should be able to run checkout from the command palette with multiple roots in the workspace', async () => {
+    it('should be able to run checkout from the Command Palette with multiple roots in the workspace', async () => {
       const mockCheckout = stub(CliExecutor.prototype, 'checkout').resolves('')
 
       stub(WorkspaceRepositories.prototype, 'getDvcRoots').returns([
@@ -72,7 +72,7 @@ suite('Workspace Repositories Test Suite', () => {
       expect(mockQuickPickOne).to.be.calledOnce
     })
 
-    it('should not run pull from the command palette if the user fails to select from multiple roots in the workspace', async () => {
+    it('should not run pull from the Command Palette if the user fails to select from multiple roots in the workspace', async () => {
       const mockPull = stub(CliExecutor.prototype, 'pull').resolves('')
 
       stub(WorkspaceRepositories.prototype, 'getDvcRoots').returns([

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Output channel`
	`1`	`+# Output Channel`
`2`	`2`
`3`	`3`	All `DVC` CLI commands generate two entries in this extension's dedicated output
`4`	`4`	`channel.`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Source control management`
	`1`	`+# Source Control Management`
`2`	`2`
`3`	`3`	Resources tracked by `DVC` can be managed through the SCM view.
`4`	`4`