Skip to content

Commit 680877e

Browse files
authored
Fix "Get Started" walkthrough typos and outdated mentions (#4118)
1 parent 8228ce0 commit 680877e

File tree

8 files changed

+20
-17
lines changed

8 files changed

+20
-17
lines changed

extension/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1469,7 +1469,7 @@
14691469
},
14701470
{
14711471
"view": "dvc.views.welcome",
1472-
"contents": "The extension is currently unable to initialize.\n[Show Setup](command:dvc.showDvcSetup)\nNew to the extension? Watch a [demo of the extension](https://youtu.be/E26IaD7bNXg?t=1177) in action or quickly try the extension yourself with our [example project](https://github.com/iterative/example-dvc-experiments.git). Dive deeper into DVC at [dvc.org](https://dvc.org/).",
1472+
"contents": "The extension is currently unable to initialize.\n[Show Setup](command:dvc.showDvcSetup)\nNew to the extension? Watch a [demo of the extension](https://youtu.be/E26IaD7bNXg?t=1177) in action or quickly try the extension yourself with our [example project](https://github.com/iterative/example-get-started-experiments). Dive deeper into DVC at [dvc.org](https://dvc.org/).",
14731473
"when": "true"
14741474
},
14751475
{

extension/resources/walkthrough/command-palette.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
> ℹ️ The extension's features cannot be accessed until DVC is installed and a
44
> DVC project is available in the workspace. Please refer to the
5-
> [setup page](command:dvc.dvc.showDvcSetup) if you have not setup DVC yet.
5+
> [setup page](command:dvc.showDvcSetup) if you have not setup DVC yet.
66
77
This extension makes extensive use of the
8-
[Command Palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette).
9-
Which can be accessed via `F1` or ⇧⌃P on Windows/Linux or ⇧⌘P on macOS.
8+
[Command Palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette)
9+
which can be accessed via `F1` or ⇧⌃P on Windows/Linux or ⇧⌘P on macOS.
1010

1111
To see a list of available commands click [here](command:dvc.showCommands) or
1212
type DVC into the Command Palette.

extension/resources/walkthrough/experiments-table.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Use `DVC: Show Experiments` from the
1313
[Command Palette](command:workbench.action.quickOpen?%22>DVC:%20Show%20Experiments%22)
1414
to open up the experiments table or access it.
1515

16-
The table provides context menus to access basic operation on experiments and
16+
The table provides context menus to access basic operations on experiments and
1717
table headers. You can edit parameters, sort or filter, run new experiments and
1818
more:
1919

extension/resources/walkthrough/live-plots.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ updates:
1010
</p>
1111

1212
This functionality comes baked in when you update your plots files in your
13-
training code. For example like this, using the
13+
training code. For examples like this, use the
1414
[DVCLive](https://dvc.org/doc/dvclive) library that also
1515
[supports](https://dvc.org/doc/dvclive/ml-frameworks) many popular ML frameworks
1616
to automate this process:

extension/resources/walkthrough/more-resources.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
- Browse all available [`dvc` commands] and [Python API] functions.
1313

14-
- Take our [free course] and become a certified in Iterative.ai tools!
14+
- Take our [free course] and become certified in Iterative.ai tools!
1515

1616
- Play with a ready-to-use [example project].
1717

@@ -30,7 +30,7 @@
3030
[python api]: https://dvc.org/doc/api-reference
3131
[free course]: https://learn.iterative.ai/
3232
[contribute]: https://dvc.org/doc/contributing/core
33-
[example project]: https://github.com/iterative/example-get-started
33+
[example project]: https://github.com/iterative/example-get-started-experiments
3434
[blog]: https://dvc.org/blog
3535
[community]: https://dvc.org/community
3636
[dvc github repository]: https://github.com/iterative/dvc

extension/resources/walkthrough/plots.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,16 +74,17 @@ rendered side by side for the selected experiments.
7474
alt="Plots: Custom" />
7575
</p>
7676

77-
**Custom** plots compare a chosen [metric] and param across experiments.
77+
**Custom** plots compare a chosen [metric] and [param] across experiments.
7878

7979
[metric]: https://dvc.org/doc/command-reference/metrics
80+
[param]: https://dvc.org/doc/command-reference/params
8081

8182
<p align="center">
8283
<img src="images/plots-view-icon.png"
8384
alt="Plots View Icon" />
8485
</p>
8586

86-
The **Plots Dashboard** can be configured and accessed from the _Plots_ and
87-
_Experiments_ side panels in the [**DVC View**](command:views.dvc-views).
87+
The **Plots Dashboard** can be configured and accessed from the _Plots_ side
88+
panel in the [**DVC View**](command:views.dvc-views).
8889

8990
> This is equivalent to the [`dvc plots show`] and [`dvc plots diff`] commands.

extension/resources/walkthrough/run-experiments.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,10 @@
33
You edit your code, edit or add more data, applying a new combination of
44
hyperparameters- you have a new idea to try 💡!
55

6-
This extension provides many different ways to run a new experiment or queue one
7-
to be run later in the background or in parallel. This functionality wraps up
8-
the [`dvc exp run`](https://dvc.org/doc/command-reference/exp/run) command.
6+
This extension provides many different ways to run a new experiment. You can
7+
also queue one to be run later in the background or in parallel. This
8+
functionality wraps up the
9+
[`dvc exp run`](https://dvc.org/doc/command-reference/exp/run) command.
910

1011
The basic one is the set of buttons that are available when the experiments
1112
table or parameters file are open:

extension/resources/walkthrough/view-container.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,8 @@ project available in the workspace:
2323
> [GitHub](https://github.com/iterative/vscode-dvc/issues). We are happy to
2424
> help.
2525
26-
If DVC and the extension are initialized, side bar will expose multiple views:
26+
If DVC and the extension are initialized, the side bar will expose multiple
27+
views:
2728

2829
<p align="center">
2930
<img src="images/view-container.png"
@@ -36,6 +37,6 @@ If DVC and the extension are initialized, side bar will expose multiple views:
3637
columns.
3738
- `PLOTS`. Used to fine-tune the plots dashboard, e.g. by toggling plots
3839
visibility.
39-
- `FILTER BY`. Used to view, add, or remove metrics and parameters filters.
40+
- `FILTER BY`. Used to view, add, or remove metrics/parameters filters. These
41+
will hide specific experiments in the table.
4042
- `SORT BY`. Used to display and configure how the experiments table is sorted.
41-
These will hide specific experiments in the table.

0 commit comments

Comments
 (0)