From 680877e438ac2ff31158f93daafda081fae994dc Mon Sep 17 00:00:00 2001 From: Julie G <43496356+julieg18@users.noreply.github.com> Date: Thu, 15 Jun 2023 11:25:24 -0500 Subject: [PATCH] Fix "Get Started" walkthrough typos and outdated mentions (#4118) --- extension/package.json | 2 +- extension/resources/walkthrough/command-palette.md | 6 +++--- extension/resources/walkthrough/experiments-table.md | 2 +- extension/resources/walkthrough/live-plots.md | 2 +- extension/resources/walkthrough/more-resources.md | 4 ++-- extension/resources/walkthrough/plots.md | 7 ++++--- extension/resources/walkthrough/run-experiments.md | 7 ++++--- extension/resources/walkthrough/view-container.md | 7 ++++--- 8 files changed, 20 insertions(+), 17 deletions(-) diff --git a/extension/package.json b/extension/package.json index bada76cc52..8a0dae99bf 100644 --- a/extension/package.json +++ b/extension/package.json @@ -1469,7 +1469,7 @@ }, { "view": "dvc.views.welcome", - "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/).", + "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/).", "when": "true" }, { diff --git a/extension/resources/walkthrough/command-palette.md b/extension/resources/walkthrough/command-palette.md index 2bf4e3bd07..96cbdda510 100644 --- a/extension/resources/walkthrough/command-palette.md +++ b/extension/resources/walkthrough/command-palette.md @@ -2,11 +2,11 @@ > ℹ️ 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. +> [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. +[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. To see a list of available commands click [here](command:dvc.showCommands) or type DVC into the Command Palette. diff --git a/extension/resources/walkthrough/experiments-table.md b/extension/resources/walkthrough/experiments-table.md index c3114543f5..1c8893e2e2 100644 --- a/extension/resources/walkthrough/experiments-table.md +++ b/extension/resources/walkthrough/experiments-table.md @@ -13,7 +13,7 @@ Use `DVC: Show Experiments` from the [Command Palette](command:workbench.action.quickOpen?%22>DVC:%20Show%20Experiments%22) to open up the experiments table or access it. -The table provides context menus to access basic operation on experiments and +The table provides context menus to access basic operations on experiments and table headers. You can edit parameters, sort or filter, run new experiments and more: diff --git a/extension/resources/walkthrough/live-plots.md b/extension/resources/walkthrough/live-plots.md index 02bbb88dc1..f395ddcaa0 100644 --- a/extension/resources/walkthrough/live-plots.md +++ b/extension/resources/walkthrough/live-plots.md @@ -10,7 +10,7 @@ updates:

This functionality comes baked in when you update your plots files in your -training code. For example like this, using the +training code. For examples like this, use the [DVCLive](https://dvc.org/doc/dvclive) library that also [supports](https://dvc.org/doc/dvclive/ml-frameworks) many popular ML frameworks to automate this process: diff --git a/extension/resources/walkthrough/more-resources.md b/extension/resources/walkthrough/more-resources.md index 6d04ce809c..3de614cb57 100644 --- a/extension/resources/walkthrough/more-resources.md +++ b/extension/resources/walkthrough/more-resources.md @@ -11,7 +11,7 @@ - Browse all available [`dvc` commands] and [Python API] functions. -- Take our [free course] and become a certified in Iterative.ai tools! +- Take our [free course] and become certified in Iterative.ai tools! - Play with a ready-to-use [example project]. @@ -30,7 +30,7 @@ [python api]: https://dvc.org/doc/api-reference [free course]: https://learn.iterative.ai/ [contribute]: https://dvc.org/doc/contributing/core -[example project]: https://github.com/iterative/example-get-started +[example project]: https://github.com/iterative/example-get-started-experiments [blog]: https://dvc.org/blog [community]: https://dvc.org/community [dvc github repository]: https://github.com/iterative/dvc diff --git a/extension/resources/walkthrough/plots.md b/extension/resources/walkthrough/plots.md index 1fc1d2c0fe..e7b6335d70 100644 --- a/extension/resources/walkthrough/plots.md +++ b/extension/resources/walkthrough/plots.md @@ -74,16 +74,17 @@ rendered side by side for the selected experiments. alt="Plots: Custom" />

-**Custom** plots compare a chosen [metric] and param across experiments. +**Custom** plots compare a chosen [metric] and [param] across experiments. [metric]: https://dvc.org/doc/command-reference/metrics +[param]: https://dvc.org/doc/command-reference/params

Plots View Icon

-The **Plots Dashboard** can be configured and accessed from the _Plots_ and -_Experiments_ side panels in the [**DVC View**](command:views.dvc-views). +The **Plots Dashboard** can be configured and accessed from the _Plots_ side +panel in the [**DVC View**](command:views.dvc-views). > This is equivalent to the [`dvc plots show`] and [`dvc plots diff`] commands. diff --git a/extension/resources/walkthrough/run-experiments.md b/extension/resources/walkthrough/run-experiments.md index 704e165c7a..e9f6ff4d5c 100644 --- a/extension/resources/walkthrough/run-experiments.md +++ b/extension/resources/walkthrough/run-experiments.md @@ -3,9 +3,10 @@ You edit your code, edit or add more data, applying a new combination of hyperparameters- you have a new idea to try 💡! -This extension provides many different ways to run a new experiment or queue one -to be run later in the background or in parallel. This functionality wraps up -the [`dvc exp run`](https://dvc.org/doc/command-reference/exp/run) command. +This extension provides many different ways to run a new experiment. You can +also queue one to be run later in the background or in parallel. This +functionality wraps up the +[`dvc exp run`](https://dvc.org/doc/command-reference/exp/run) command. The basic one is the set of buttons that are available when the experiments table or parameters file are open: diff --git a/extension/resources/walkthrough/view-container.md b/extension/resources/walkthrough/view-container.md index 84691faa23..502acc307f 100644 --- a/extension/resources/walkthrough/view-container.md +++ b/extension/resources/walkthrough/view-container.md @@ -23,7 +23,8 @@ project available in the workspace: > [GitHub](https://github.com/iterative/vscode-dvc/issues). We are happy to > help. -If DVC and the extension are initialized, side bar will expose multiple views: +If DVC and the extension are initialized, the side bar will expose multiple +views: