Skip to content
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

Merged
merged 11 commits into from Jun 20, 2022
Merged

readme: more VS Code Extension info. #7916

merged 11 commits into from Jun 20, 2022

Conversation

jorgeorpinel
Copy link
Contributor

Preview: https://github.com/iterative/dvc/tree/readme/vsce#readme

README.rst Outdated
Comment on lines 35 to 40
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.
Copy link
Contributor Author

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?

Copy link
Contributor Author

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)

Copy link
Contributor

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

README.rst Outdated Show resolved Hide resolved
README.rst Outdated

Please read `Get Started <https://dvc.org/doc/get-started>`_ guide for a full version. Common workflow commands include:
Copy link
Contributor

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.

Copy link
Contributor Author

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.

README.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@dberenbaum dberenbaum left a 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>
@jorgeorpinel jorgeorpinel force-pushed the readme/vsce branch 5 times, most recently from 7f9a799 to 6f4454c Compare June 18, 2022 01:11
@jorgeorpinel
Copy link
Contributor Author

primary goal was to include a vs code gif

Yes. I had to move some stuff around to make room, but it's in now. PTAL when you can @dberenbaum

@jorgeorpinel jorgeorpinel marked this pull request as ready for review June 18, 2022 01:14
@jorgeorpinel jorgeorpinel requested a review from a team as a code owner June 18, 2022 01:14
@jorgeorpinel jorgeorpinel requested a review from efiop June 18, 2022 01:14
@jorgeorpinel jorgeorpinel mentioned this pull request Jun 18, 2022
6 tasks
@jorgeorpinel jorgeorpinel self-assigned this Jun 18, 2022
Copy link
Member

@shcheklein shcheklein left a 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

Copy link
Contributor Author

@jorgeorpinel jorgeorpinel left a 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 ⏳

README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Show resolved Hide resolved
Copy link
Member

@shcheklein shcheklein left a 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?

@jorgeorpinel
Copy link
Contributor Author

jorgeorpinel commented Jun 20, 2022

@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 dvc binary, but the extension guides you and maybe that can be automated at some point?

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.

@jorgeorpinel
Copy link
Contributor Author

jorgeorpinel commented Jun 20, 2022

not a DVC core installation method, but it's kind of a DVC (as a whole) installation method

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.

@efiop efiop merged commit 604e017 into main Jun 20, 2022
@efiop efiop deleted the readme/vsce branch June 20, 2022 13:10
efiop pushed a commit that referenced this pull request Jun 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants