Skip to content

Commit 9633dfc

Browse files
authored
Add "Setup" section to "Get Started" walkthrough (#4154)
1 parent 48ed9c4 commit 9633dfc

File tree

4 files changed

+27
-4
lines changed

4 files changed

+27
-4
lines changed

extension/package.json

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1508,6 +1508,17 @@
15081508
"title": "Get Started",
15091509
"description": "Your first steps to build better models faster with experiment tracking and dataset versioning",
15101510
"steps": [
1511+
{
1512+
"id": "dvc.setupPage",
1513+
"title": "Setup",
1514+
"description": "Get started with DVC or setup additonal features.\n[Show Setup](command:dvc.showSetup)",
1515+
"media": {
1516+
"markdown": "resources/walkthrough/setup.md"
1517+
},
1518+
"completionEvents": [
1519+
"onCommand:dvc.showSetup"
1520+
]
1521+
},
15111522
{
15121523
"id": "dvc.showCommands",
15131524
"title": "Available Commands",

extension/resources/walkthrough/command-palette.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
# Command Palette
22

3-
> ℹ️ The extension's features cannot be accessed until DVC is installed and a
4-
> DVC project is available in the workspace. Please refer to the
5-
> [setup page](command:dvc.showDvcSetup) if you have not setup DVC yet.
6-
73
This extension makes extensive use of the
84
[Command Palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette)
95
which can be accessed via `F1` or ⇧⌃P on Windows/Linux or ⇧⌘P on macOS.
64.9 KB
Loading
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Setup
2+
3+
The extension's key features cannot be accessed until DVC is installed and a DVC
4+
project is available in the workspace. The
5+
[setup page](command:dvc.showDvcSetup) can assist you with setting up your DVC
6+
project, along with configuring additional features such as connecting to Studio
7+
and remotes.
8+
9+
<p align="center">
10+
<img src="images/setup-view.png"
11+
alt="DVC setup page" />
12+
</p>
13+
14+
Use `DVC: Show Setup` from the
15+
[Command Palette](command:workbench.action.quickOpen?%22>DVC:%20Show%20Experiments%22)
16+
to access it.

0 commit comments

Comments
 (0)