Consolidate Setup and "Get Started" walkthrough (#3993)

Author: julieg18

README.md

@@ -146,16 +146,16 @@ These are the VS Code [settings] available for the Extension:
 
 [settings]: https://code.visualstudio.com/docs/getstarted/settings
 
-| **Option**                             | **Description**                                                                                                                                          |
-| -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `dvc.dvcPath`                          | Path or shell command to the DVC binary. Required unless Microsoft's [Python extension] is installed and the `dvc` package found in its environment.     |
-| `dvc.pythonPath`                       | Path to the desired Python interpreter to use with DVC. Should only be utilized when using a virtual environment without Microsoft's [Python extension]. |
-| `dvc.experimentsTableHeadMaxHeight`    | Maximum height of experiment table head rows.                                                                                                            |
-| `dvc.focusedProjects`                  | A subset of paths to the workspace's available DVC projects. Using this option will override project auto-discovery.                                     |
-| `dvc.doNotShowWalkthroughAfterInstall` | Do not prompt to show the Get Started page after installing. Useful for pre-configured development environments                                          |
-| `dvc.doNotRecommendAddStudioToken`     | Do not prompt to add a [studio.token] to the global DVC config, which enables automatic sharing of experiments to [Studio].                              |
-| `dvc.doNotRecommendRedHatExtension`    | Do not prompt to install the Red Hat YAML extension, which helps with DVC YAML schema validation (`dvc.yaml` and `.dvc` files).                          |
-| `dvc.doNotShowCliUnavailable`          | Do not warn when the workspace contains a DVC project but the DVC binary is unavailable.                                                                 |
+| **Option**                          | **Description**                                                                                                                                          |
+| ----------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `dvc.dvcPath`                       | Path or shell command to the DVC binary. Required unless Microsoft's [Python extension] is installed and the `dvc` package found in its environment.     |
+| `dvc.pythonPath`                    | Path to the desired Python interpreter to use with DVC. Should only be utilized when using a virtual environment without Microsoft's [Python extension]. |
+| `dvc.experimentsTableHeadMaxHeight` | Maximum height of experiment table head rows.                                                                                                            |
+| `dvc.focusedProjects`               | A subset of paths to the workspace's available DVC projects. Using this option will override project auto-discovery.                                     |
+| `dvc.doNotShowSetupAfterInstall`    | Do not prompt to show the setup page after installing. Useful for pre-configured development environments                                                |
+| `dvc.doNotRecommendAddStudioToken`  | Do not prompt to add a [studio.token] to the global DVC config, which enables automatic sharing of experiments to [Studio].                              |
+| `dvc.doNotRecommendRedHatExtension` | Do not prompt to install the Red Hat YAML extension, which helps with DVC YAML schema validation (`dvc.yaml` and `.dvc` files).                          |
+| `dvc.doNotShowCliUnavailable`       | Do not warn when the workspace contains a DVC project but the DVC binary is unavailable.                                                                 |
 
 > **Note** that the `Setup The Workspace` command helps you set up the basic
 > ones at the [Workspace level] (saved to `.vscode/setting.json`).

extension/package.json

@@ -615,8 +615,8 @@
           "type": "boolean",
           "default": null
         },
-        "dvc.doNotShowWalkthroughAfterInstall": {
-          "description": "Do not prompt to show the Get Started page after installing. Useful for pre-configured development environments.",
+        "dvc.doNotShowSetupAfterInstall": {
+          "description": "Do not prompt to show the setup page after installing. Useful for pre-configured development environments.",
           "type": "boolean",
           "default": null
         },
@@ -1512,32 +1512,6 @@
         "title": "Get Started",
         "description": "Your first steps to build better models faster with experiment tracking and dataset versioning",
         "steps": [
-          {
-            "id": "dvc.installDVC",
-            "title": "Install DVC",
-            "description": "This extension requires DVC to be installed.\n\n[Show Setup](command:dvc.showDvcSetup)\n",
-            "media": {
-              "markdown": "resources/walkthrough/install-dvc.md"
-            },
-            "completionEvents": [
-              "onLink:https://dvc.org",
-              "onLink:https://dvc.org/doc/install",
-              "onCommand:dvc.setupWorkspace"
-            ]
-          },
-          {
-            "id": "dvc.setupProject",
-            "title": "Setup a DVC Project",
-            "description": "Try an example DVC project or set one up quickly, and start tracking datasets, models, metrics, and plots\n\n[Example Project](https://github.com/iterative/example-get-started)\n",
-            "media": {
-              "markdown": "resources/walkthrough/setup-project.md"
-            },
-            "completionEvents": [
-              "onLink:https://github.com/iterative/example-get-started",
-              "onLink:https://github.com/iterative/vscode-dvc-demo",
-              "onLink:https://dvc.org/doc/dvclive"
-            ]
-          },
           {
             "id": "dvc.showCommands",
             "title": "Available Commands",

extension/resources/walkthrough/command-palette.md

@@ -1,3 +1,7 @@
+> ℹ️ The extension's features cannot be accessed until DVC is installed and a
+> DVC project is available in the workspace. Please refer to the
+> [setup page](command:dvc.dvc.showDvcSetup) if you have not setup DVC yet.
+
 # Command Palette
 
 This extension makes extensive use of the

extension/resources/walkthrough/experiments-table.md

@@ -1,9 +1,5 @@
 # Experiments Table
 
-> ❗ DVC should be installed and DVC project available in the workspace for this
-> and the next steps to work properly. Please refer to first two steps of this
-> guide.
-
 As you change code, parameters, data and run new experiments this table will
 keep all the details about your iterations. It can be manipulated and configured
 using the [DVC side panel](command:workbench.view.extension.dvc-views). This is

extension/resources/walkthrough/images/install-dvc-status-bar-detected.png

@@ -29,10 +29,8 @@ import {
 } from './telemetry'
 import { RegisteredCommands } from './commands/external'
 import { StopWatch } from './util/time'
-import {
-  registerWalkthroughCommands,
-  showWalkthroughOnFirstUse
-} from './vscode/walkthrough'
+import { registerWalkthroughCommands } from './vscode/walkthrough'
+import { showSetupOnFirstUse } from './setup/util'
 import { WorkspaceRepositories } from './repository/workspace'
 import { recommendRedHatExtensionOnce } from './vscode/recommend'
 import { WorkspacePlots } from './plots/workspace'
@@ -258,7 +256,7 @@ class Extension extends Disposable {
 
     registerPersistenceCommands(context.workspaceState, this.internalCommands)
 
-    void showWalkthroughOnFirstUse(env.isNewAppInstall)
+    void showSetupOnFirstUse(env.isNewAppInstall)
     this.dispose.track(recommendRedHatExtensionOnce())
 
     this.dispose.track(new LanguageClient())

extension/resources/walkthrough/install-dvc.md

@@ -1,13 +1,13 @@
 import { commands } from 'vscode'
-import { showWalkthroughOnFirstUse } from './walkthrough'
-import { ConfigKey, getConfigValue, setUserConfigValue } from './config'
-import { Toast } from './toast'
-import { Response } from './response'
+import { showSetupOnFirstUse } from './util'
+import { ConfigKey, getConfigValue, setUserConfigValue } from '../vscode/config'
+import { Toast } from '../vscode/toast'
+import { Response } from '../vscode/response'
 import { RegisteredCommands } from '../commands/external'
 
 jest.mock('vscode')
-jest.mock('./toast')
-jest.mock('./config')
+jest.mock('../vscode/toast')
+jest.mock('../vscode/config')
 
 const mockedCommands = jest.mocked(commands)
 const mockedExecuteCommand = jest.fn()
@@ -24,59 +24,59 @@ beforeEach(() => {
   jest.resetAllMocks()
 })
 
-describe('showWalkthroughOnFirstUse', () => {
-  it('should ask to show the walkthrough after a new install', async () => {
-    await showWalkthroughOnFirstUse(true)
+describe('showSetupOnFirstUse', () => {
+  it('should ask to show the setup page after a new install', async () => {
+    await showSetupOnFirstUse(true)
     expect(mockedAskShowOrCloseOrNever).toHaveBeenCalledTimes(1)
   })
 
-  it('should not ask to show the walkthrough when the install is not new', async () => {
-    await showWalkthroughOnFirstUse(false)
+  it('should not ask to show the setup page when the install is not new', async () => {
+    await showSetupOnFirstUse(false)
     expect(mockedAskShowOrCloseOrNever).not.toHaveBeenCalled()
   })
 
-  it('should not ask to show the walkthrough when the user has set a config option', async () => {
+  it('should not ask to show the setup page when the user has set a config option', async () => {
     mockedGetConfigValue.mockReturnValueOnce(true)
-    await showWalkthroughOnFirstUse(true)
+    await showSetupOnFirstUse(true)
     expect(mockedAskShowOrCloseOrNever).not.toHaveBeenCalled()
     expect(mockedGetConfigValue).toHaveBeenCalledTimes(1)
     expect(mockedGetConfigValue).toHaveBeenCalledWith(
-      ConfigKey.DO_NOT_SHOW_WALKTHROUGH_AFTER_INSTALL
+      ConfigKey.DO_NOT_SHOW_SETUP_AFTER_INSTALL
     )
   })
 
   it('should set the config option if the user responds with never', async () => {
     mockedAskShowOrCloseOrNever.mockResolvedValueOnce(Response.NEVER)
-    await showWalkthroughOnFirstUse(true)
+    await showSetupOnFirstUse(true)
 
     expect(mockedSetConfigValue).toHaveBeenCalledTimes(1)
     expect(mockedSetConfigValue).toHaveBeenCalledWith(
-      ConfigKey.DO_NOT_SHOW_WALKTHROUGH_AFTER_INSTALL,
+      ConfigKey.DO_NOT_SHOW_SETUP_AFTER_INSTALL,
       true
     )
   })
 
-  it('should show the walkthrough if the user responds with show', async () => {
+  it('should show the setup page if the user responds with show', async () => {
     mockedAskShowOrCloseOrNever.mockResolvedValueOnce(Response.SHOW)
-    await showWalkthroughOnFirstUse(true)
+    await showSetupOnFirstUse(true)
 
     expect(mockedSetConfigValue).not.toHaveBeenCalled()
     expect(mockedExecuteCommand).toHaveBeenCalledWith(
-      RegisteredCommands.EXTENSION_GET_STARTED
+      RegisteredCommands.SETUP_SHOW
     )
   })
 
   it('should take no action if the user closes the dialog', async () => {
     mockedAskShowOrCloseOrNever.mockResolvedValueOnce(undefined)
-    await showWalkthroughOnFirstUse(true)
+    await showSetupOnFirstUse(true)
 
     expect(mockedSetConfigValue).not.toHaveBeenCalled()
     expect(mockedExecuteCommand).not.toHaveBeenCalled()
   })
 
   it('should take no action if the user respond with close', async () => {
     mockedAskShowOrCloseOrNever.mockResolvedValueOnce(Response.CLOSE)
-    await showWalkthroughOnFirstUse(true)
+    await showSetupOnFirstUse(true)
 
     expect(mockedSetConfigValue).not.toHaveBeenCalled()
     expect(mockedExecuteCommand).not.toHaveBeenCalled()

extension/resources/walkthrough/setup-project.md

@@ -0,0 +1,27 @@
+import { commands } from 'vscode'
+import { RegisteredCommands } from '../commands/external'
+import { ConfigKey, getConfigValue, setUserConfigValue } from '../vscode/config'
+import { Response } from '../vscode/response'
+import { Toast } from '../vscode/toast'
+
+export const showSetupOnFirstUse = async (
+  isNewAppInstall: boolean
+): Promise<void> => {
+  if (
+    !isNewAppInstall ||
+    getConfigValue<boolean>(ConfigKey.DO_NOT_SHOW_SETUP_AFTER_INSTALL)
+  ) {
+    return
+  }
+
+  const response = await Toast.askShowOrCloseOrNever(
+    'Need help? Go to our setup view.'
+  )
+
+  if (response === Response.SHOW) {
+    void commands.executeCommand(RegisteredCommands.SETUP_SHOW)
+  }
+  if (response === Response.NEVER) {
+    void setUserConfigValue(ConfigKey.DO_NOT_SHOW_SETUP_AFTER_INSTALL, true)
+  }
+}