Skip to content

Commit 6dda738

Browse files
authored
Improve README (#4086)
1 parent ed0a9e7 commit 6dda738

File tree

2 files changed

+18
-7
lines changed

2 files changed

+18
-7
lines changed

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -60,14 +60,12 @@ databases are required.
6060

6161
1. [Install DVC](https://dvc.org/doc/install) on your system.
6262
2. Install [this extension] in VS Code.
63-
3. Follow the [Get Started](#useful-commands) walkthrough!
63+
3. Follow the steps set out on the [Setup](#useful-commands) page!
6464

6565
<!-- prettier-ignore -->
6666
> 💡 Feel free to try our [example DVC project] first! Opening it [with Github
6767
> Codespaces] will include this extension automatically.
6868
69-
![Initial Get Started page](https://raw.githubusercontent.com/iterative/vscode-dvc/main/extension/docs/walkthroughs.png)
70-
7169
[this extension]:
7270
https://marketplace.visualstudio.com/items?itemName=Iterative.dvc
7371
[example dvc project]: https://github.com/iterative/example-get-started
@@ -76,10 +74,10 @@ databases are required.
7674

7775
### Learn more about DVC (Data Version Control)
7876

79-
See the DVC documentation to Get Started with [Experiment Versioning] or [Data
80-
Management]. For deeper learning, try our [free course]! [More resources]
77+
See the DVC documentation to Get Started with [Experiments] or [Data
78+
Management]. For deeper learning, try our [free course]! [More resources].
8179

82-
[experiment versioning]: https://dvc.org/doc/start/experiments
80+
[experiments]: https://dvc.org/doc/start/experiments
8381
[data management]: https://dvc.org/doc/start/data-management
8482
[free course]: https://learn.iterative.ai/
8583
[more resources]:
@@ -167,15 +165,24 @@ the Python extension's selected interpreter will be used to locate DVC. The
167165
`PYTHONPATH` environment variable identified via the [python.envFile] config
168166
setting is also respected.
169167

168+
### Studio
169+
170+
[Studio] is a collaboration platform for Machine Learning teams. The extension
171+
will help you to connect to [Studio] by providing guidance and managing the
172+
required [DVC config options]. See the Studio section of the Setup page for more
173+
information.
174+
170175
[python extension]:
171176
https://marketplace.visualstudio.com/items?itemName=ms-python.python
172177
[studio.token]:
173178
https://dvc.org/doc/user-guide/project-structure/configuration#studio
174-
[Studio]: https://studio.iterative.ai
179+
[studio]: https://studio.iterative.ai
175180
[workspace level]:
176181
https://code.visualstudio.com/docs/getstarted/settings#_workspace-settings
177182
[python.envFile]:
178183
https://code.visualstudio.com/docs/python/environments#_use-of-the-pythonpath-variable
184+
[dvc config options]:
185+
https://dvc.org/doc/user-guide/project-structure/configuration#studio
179186

180187
## Debugging
181188

extension/resources/walkthrough/more-resources.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@
2020
- Check out the [DVC GitHub repository], where you can find and report issues,
2121
or [contribute] to the open-source project.
2222

23+
- Get introduced to [Studio], the collaboration platform for Machine Learning
24+
teams.
25+
2326
[hands-on tour]: https://dvc.org/doc/start
2427
[user guide]: https://dvc.org/doc/user-guide
2528
[use cases]: https://dvc.org/doc/use-cases
@@ -31,3 +34,4 @@
3134
[blog]: https://dvc.org/blog
3235
[community]: https://dvc.org/community
3336
[dvc github repository]: https://github.com/iterative/dvc
37+
[studio]: https://studio.iterative.ai/

0 commit comments

Comments
 (0)