Skip to content

Commit

Permalink
Add "Setup" section to "Get Started" walkthrough (#4154)
Browse files Browse the repository at this point in the history
  • Loading branch information
julieg18 authored Jun 21, 2023
1 parent 48ed9c4 commit 9633dfc
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 4 deletions.
11 changes: 11 additions & 0 deletions extension/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -1508,6 +1508,17 @@
"title": "Get Started",
"description": "Your first steps to build better models faster with experiment tracking and dataset versioning",
"steps": [
{
"id": "dvc.setupPage",
"title": "Setup",
"description": "Get started with DVC or setup additonal features.\n[Show Setup](command:dvc.showSetup)",
"media": {
"markdown": "resources/walkthrough/setup.md"
},
"completionEvents": [
"onCommand:dvc.showSetup"
]
},
{
"id": "dvc.showCommands",
"title": "Available Commands",
Expand Down
4 changes: 0 additions & 4 deletions extension/resources/walkthrough/command-palette.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
# Command Palette

> ℹ️ 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.showDvcSetup) if you have not setup DVC yet.
This extension makes extensive use of the
[Command Palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette)
which can be accessed via `F1` or ⇧⌃P on Windows/Linux or ⇧⌘P on macOS.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 16 additions & 0 deletions extension/resources/walkthrough/setup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Setup

The extension's key features cannot be accessed until DVC is installed and a DVC
project is available in the workspace. The
[setup page](command:dvc.showDvcSetup) can assist you with setting up your DVC
project, along with configuring additional features such as connecting to Studio
and remotes.

<p align="center">
<img src="images/setup-view.png"
alt="DVC setup page" />
</p>

Use `DVC: Show Setup` from the
[Command Palette](command:workbench.action.quickOpen?%22>DVC:%20Show%20Experiments%22)
to access it.

0 comments on commit 9633dfc

Please sign in to comment.