diff --git a/extension/package.json b/extension/package.json
index a313e6d8bd..d23edf13ae 100644
--- a/extension/package.json
+++ b/extension/package.json
@@ -9,7 +9,7 @@
"extensionDependencies": [
"vscode.git"
],
- "version": "0.3.0",
+ "version": "0.2.25",
"license": "Apache-2.0",
"readme": "./README.md",
"repository": {
@@ -1341,30 +1341,33 @@
"walkthroughs": [
{
"id": "welcome",
- "title": "Get Started with DVC",
- "description": "Your first steps to set up a DVC project with all the powerful tools and features that the DVC extension has to offer!",
+ "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": "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": "This 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"
},
"completionEvents": [
"onLink:https://dvc.org",
- "onLink:https://dvc.org/doc/install"
+ "onLink:https://dvc.org/doc/install",
+ "onCommand:dvc.setupWorkspace"
]
},
{
- "id": "dvc.setup",
- "title": "Setup The Workspace",
- "description": "Setup the workspace for the DVC extension.\n[Setup The Workspace](command:dvc.setupWorkspace)",
+ "id": "dvc.setupProject",
+ "title": "Setup Project",
+ "description": "Try an example project and setup DVC to start tracking datasets, models, metrics, and plots\n\n[Example Project](https://github.com/iterative/example-get-started)\n",
"media": {
- "markdown": "resources/walkthrough/setup-workspace.md"
+ "markdown": "resources/walkthrough/setup-project.md"
},
"completionEvents": [
- "onCommand:dvc.setupWorkspace"
+ "onLink:https://github.com/iterative/example-get-started",
+ "onLink:https://github.com/iterative/vscode-dvc/tree/main/demo",
+ "onLink:https://dvc.org/doc/dvclive"
]
},
{
@@ -1376,44 +1379,7 @@
},
"completionEvents": [
"onCommand:dvc.showCommands"
- ],
- "when": "dvc.commands.available && dvc.project.available"
- },
- {
- "id": "dvc.showOutput",
- "title": "Output Channel",
- "description": "View the DVC output channel.\n[View Output](command:dvc.showOutput)",
- "media": {
- "markdown": "resources/walkthrough/output-channel.md"
- },
- "completionEvents": [
- "onCommand:dvc.showOutput"
- ],
- "when": "dvc.commands.available && dvc.project.available"
- },
- {
- "id": "dvc.scm",
- "title": "Source Control Management",
- "description": "Open the SCM view.\n[Show SCM](command:workbench.view.scm)",
- "media": {
- "markdown": "resources/walkthrough/source-control-management.md"
- },
- "completionEvents": [
- "onCommand:workbench.view.scm"
- ],
- "when": "dvc.commands.available && dvc.project.available"
- },
- {
- "id": "dvc.tracked",
- "title": "Tracked Resources",
- "description": "Open the DVC tracked view.\n[Show Tracked](command:dvc.views.trackedExplorerTree.focus)",
- "media": {
- "markdown": "resources/walkthrough/tracked-explorer.md"
- },
- "completionEvents": [
- "onCommand:dvc.views.trackedExplorerTree.focus"
- ],
- "when": "dvc.commands.available && dvc.project.available"
+ ]
},
{
"id": "dvc.viewContainer",
@@ -1424,8 +1390,7 @@
},
"completionEvents": [
"onCommand:workbench.view.extension.dvc-views"
- ],
- "when": "dvc.commands.available && dvc.project.available"
+ ]
},
{
"id": "dvc.experimentsTable",
@@ -1436,8 +1401,7 @@
},
"completionEvents": [
"onCommand:dvc.showExperiments"
- ],
- "when": "dvc.commands.available && dvc.project.available"
+ ]
},
{
"id": "dvc.plots",
@@ -1448,8 +1412,29 @@
},
"completionEvents": [
"onCommand:dvc.showPlots"
- ],
- "when": "dvc.commands.available && dvc.project.available"
+ ]
+ },
+ {
+ "id": "dvc.tracked",
+ "title": "Tracked Resources",
+ "description": "Open the DVC tracked view.\n[Show Tracked](command:dvc.views.trackedExplorerTree.focus)",
+ "media": {
+ "markdown": "resources/walkthrough/tracked-explorer.md"
+ },
+ "completionEvents": [
+ "onCommand:dvc.views.trackedExplorerTree.focus"
+ ]
+ },
+ {
+ "id": "dvc.scm",
+ "title": "Source Control Management",
+ "description": "Open the SCM view.\n[Show SCM](command:workbench.view.scm)",
+ "media": {
+ "markdown": "resources/walkthrough/source-control-management.md"
+ },
+ "completionEvents": [
+ "onCommand:workbench.view.scm"
+ ]
},
{
"id": "dvc.learnMore",
@@ -1461,6 +1446,17 @@
"completionEvents": [
"onLink:https://dvc.org/doc"
]
+ },
+ {
+ "id": "dvc.troubleshoot",
+ "title": "Troubleshoot",
+ "description": "View the DVC output channel.\n[View Output](command:dvc.showOutput)",
+ "media": {
+ "markdown": "resources/walkthrough/troubleshoot.md"
+ },
+ "completionEvents": [
+ "onCommand:dvc.showOutput"
+ ]
}
]
}
@@ -1534,7 +1530,7 @@
"ts-loader": "^9.2.6",
"vsce": "^2.6.7",
"vscode-uri": "^3.0.2",
- "webpack": "^5.73.0",
+ "webpack": "^5.69.1",
"webpack-cli": "^4.9.2"
},
"peerDependencies": {
diff --git a/extension/resources/walkthrough/command-palette.md b/extension/resources/walkthrough/command-palette.md
index d8b030accb..9736e3c3da 100644
--- a/extension/resources/walkthrough/command-palette.md
+++ b/extension/resources/walkthrough/command-palette.md
@@ -7,5 +7,10 @@ Which can be accessed via `F1` or ⇧⌃P on Windows/Linux or ⇧⌘P on macOS.
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
index c18db9bb20..0edcb8ab94 100644
--- a/extension/resources/walkthrough/dvc-learn-more.md
+++ b/extension/resources/walkthrough/dvc-learn-more.md
@@ -8,7 +8,7 @@
- View all [available commands](https://dvc.org/doc/command-reference).
-- Check out the [DVC github repository](https://github.com/iterative/dvc) or an
+- 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/).
diff --git a/extension/resources/walkthrough/images/available-commands-command-palette.png b/extension/resources/walkthrough/images/available-commands-command-palette.png
new file mode 100644
index 0000000000..0deb9d3059
Binary files /dev/null and b/extension/resources/walkthrough/images/available-commands-command-palette.png differ
diff --git a/extension/resources/walkthrough/images/install-dvc-setup-wizard.png b/extension/resources/walkthrough/images/install-dvc-setup-wizard.png
new file mode 100644
index 0000000000..7c22a0f4ec
Binary files /dev/null and b/extension/resources/walkthrough/images/install-dvc-setup-wizard.png differ
diff --git a/extension/resources/walkthrough/images/install-dvc-status-bar-detected.png b/extension/resources/walkthrough/images/install-dvc-status-bar-detected.png
new file mode 100644
index 0000000000..17c3281b09
Binary files /dev/null and b/extension/resources/walkthrough/images/install-dvc-status-bar-detected.png differ
diff --git a/extension/resources/walkthrough/images/setup-project-dump-metrics.png b/extension/resources/walkthrough/images/setup-project-dump-metrics.png
new file mode 100644
index 0000000000..3cb7b6db75
Binary files /dev/null and b/extension/resources/walkthrough/images/setup-project-dump-metrics.png differ
diff --git a/extension/resources/walkthrough/images/setup-project-dvc-yaml-example.png b/extension/resources/walkthrough/images/setup-project-dvc-yaml-example.png
new file mode 100644
index 0000000000..dd23d0cf24
Binary files /dev/null and b/extension/resources/walkthrough/images/setup-project-dvc-yaml-example.png differ
diff --git a/extension/resources/walkthrough/images/setup-project-dvclive-metrics.png b/extension/resources/walkthrough/images/setup-project-dvclive-metrics.png
new file mode 100644
index 0000000000..9f596a4041
Binary files /dev/null and b/extension/resources/walkthrough/images/setup-project-dvclive-metrics.png differ
diff --git a/extension/resources/walkthrough/install-dvc.md b/extension/resources/walkthrough/install-dvc.md
index aca0c65a6c..c9b3ccd4c6 100644
--- a/extension/resources/walkthrough/install-dvc.md
+++ b/extension/resources/walkthrough/install-dvc.md
@@ -1,13 +1,24 @@
# Install DVC
-There are quite a few options for installing `DVC`. This extension supports
-various installation types. See the `Setup The Workspace` step for more details.
+There are a few [options](https://dvc.org/doc/install) for installing `DVC`.
+This extension supports all installation types.
-To install the latest version of `DVC` follow your platform specific guide on
-[dvc.org](https://dvc.org/doc/install).
+To verify the installation run `dvc -h` in a
+[Terminal](command:workbench.action.quickOpen?%22>Create%20New%20Terminal%22).
-To verify the installation run `dvc -h` in your terminal of choice.
+If DVC is installed as a global binary or in a Python virtual environment,
+extension should detect it automatically and you should see a DVC icon like this
+in the status bar:
-**Note**: Use `Terminal: Create New Terminal` from the Command Palette to create
-a new
-[integrated terminal](https://code.visualstudio.com/docs/editor/integrated-terminal).
+
+ 
+
+
+If you see instead the crossed circle icon, use the
+[Setup Workspace](command:dvc.setupWorkspace) wizard to manually select the
+right environment:
+
+
+ 
+
diff --git a/extension/resources/walkthrough/setup-project.md b/extension/resources/walkthrough/setup-project.md
new file mode 100644
index 0000000000..ea587be400
--- /dev/null
+++ b/extension/resources/walkthrough/setup-project.md
@@ -0,0 +1,39 @@
+# Setup DVC Project
+
+> Skip this step if you already have a DVC project with metrics, plots, and
+> params.
+
+💡 Check the [Get Started](https://github.com/iterative/example-get-started) and
+[VS Code Demo](https://github.com/iterative/vscode-dvc/tree/main/demo) projects
+to quickly try the extension.
+
+To setup the project run
+[`dvc exp init`](https://dvc.org/doc/command-reference/exp/init#example-interactive-mode)
+in a
+[Terminal](command:workbench.action.quickOpen?%22>Create%20New%20Terminal%22).
+
+It will generate a config file `dvc.yaml` that describes the project, and can
+look like this:
+
+
+ 
+
+
+💡 Names, values in this file are project dependent and can customized.
+
+DVC and this extension read experiments data from these files (`metrics.json`,
+`params.yaml`, etc). You need to instrument your code to start writing / reading
+them (example is in Python, but it can be done in any language):
+
+
+ 
+
+
+Or alternatively using the [`DVCLive`](https://dvc.org/doc/dvclive) Python
+library that can read / write a lot of different common metrics and plots:
+
+
+ 
+
diff --git a/extension/resources/walkthrough/setup-workspace.md b/extension/resources/walkthrough/setup-workspace.md
deleted file mode 100644
index ddcf02d175..0000000000
--- a/extension/resources/walkthrough/setup-workspace.md
+++ /dev/null
@@ -1,15 +0,0 @@
-# Integrating with the CLI
-
-This extension can support a global or virtual environment installation of
-`DVC`.
-
-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.
-
-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/output-channel.md b/extension/resources/walkthrough/troubleshoot.md
similarity index 100%
rename from extension/resources/walkthrough/output-channel.md
rename to extension/resources/walkthrough/troubleshoot.md