New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weβll occasionally send you account related emails.
Already on GitHub? Sign in to your account
readme: more VS Code Extension info. #7916
Conversation
b36b520
to
a7bdc1e
Compare
README.rst
Outdated
How DVC works | ||
============= | ||
|
||
We encourage you to read our `Get Started <https://dvc.org/doc/get-started>`_ guide to better understand what DVC | ||
is and how it can fit your scenarios. | ||
We encourage you to read our `Get Started | ||
<https://dvc.org/doc/get-started>`_ guides to better understand what DVC | ||
does and how it can fit your scenarios. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not directly related but we should probably move this to AFTER the Quick start sections?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- BTW it's missing info about Experiment Management (only covers Data Mgmt and Pipelines rn)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes on both counts! It's on my personal to-do list along with a host of other readme improvements.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
README.rst
Outdated
|
||
Please read `Get Started <https://dvc.org/doc/get-started>`_ guide for a full version. Common workflow commands include: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why get rid of this? I know it's above, but considering we will want to swap places, it would be good to link to get started early.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This was removed because there's 2 Quick starts now, this one is specific to command line so I linked to the Command Reference docs instead.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @jorgeorpinel! I thought the primary goal was to include a vs code gif?
Co-authored-by: Dave Berenbaum <dave@iterative.ai>
7f9a799
to
6f4454c
Compare
6f4454c
to
d3c0f08
Compare
Yes. I had to move some stuff around to make room, but it's in now. PTAL when you can @dberenbaum |
aab55ee
to
d3c0f08
Compare
c715dcf
to
ac96fc5
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jorgeorpinel could we please first do only VS Code related changes? it'll be easier to review
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Rolling back changes not directly about VS Code β³
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think VS Code can be considered an installation method, large Gif in that section is misleading to my mind. Probably it's better to have separate section about it somewhere, wdyt?
@shcheklein it's not a DVC core installation method, but it's kind of a DVC (as a whole) acquisition method. With the caveat that you need to manually install the At least that's how we're presenting the extension in the VS Code marketplace -- as DVC itself (for the most part). I also changed the intro of this README which now says "DVC is a CLI tool and VS Code Extension" BTW, should I roll that back too? Oh and it's an entry under https://dvc.org/doc/install. I'm not sure which way is best to go on, this so I'll follow your decision. I thought I was following the direction provided in the original materials and what I remember from the surrounding discussions: basically that we want to feature VS Code as DVC's main interface, and then CLI/ Python API. |
Well, I guess that makes it misleading to have it in the core repo's README like you said (yet OK in https://dvc.org/doc/install) OK I'm changing it β³ ... Done! See https://github.com/iterative/dvc/tree/readme/vsce#visual-studio-code-extension. |
Preview: https://github.com/iterative/dvc/tree/readme/vsce#readme
β I have followed the Contributing to DVC checklist.
π If this PR requires documentation updates, I have created a separate PR (or issue, at least) in dvc.org and linked it here.