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

cmd: update version ref. #1814

Merged
merged 19 commits into from
Oct 12, 2020
Merged

cmd: update version ref. #1814

merged 19 commits into from
Oct 12, 2020

Conversation

imhardikj
Copy link
Contributor

Fixes #1635

  • Updates version ref.

@shcheklein shcheklein temporarily deployed to dvc-landing-versioncmd-h5yeruw September 26, 2020 19:07 Inactive
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-versioncmd-h5yeruw September 28, 2020 05:34 Inactive
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-versioncmd-h5yeruw September 28, 2020 06:13 Inactive
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-versioncmd-h5yeruw September 28, 2020 06:20 Inactive
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-versioncmd-h5yeruw September 28, 2020 06:22 Inactive
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-versioncmd-h5yeruw September 28, 2020 06:22 Inactive
Copy link
Contributor

@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.

Good so far @imhardikj! Left some specific comments above.

But also, it feels like it needs more updates (keep in mind this is a pretty old doc.) Some possible issues I noticed after a quick readthrough:

  • Rewrite "Official release": Not sure why the paragraph starts with "These instructions..." — should start by explaining what the official release (number) is.
  • Link to https://www.pypa.io/ ?
  • In "Development version", should there be a pip install... code block that doesn't correspond to the instructions in https://dvc.org/doc/user-guide/contributing/core#development-environment? (Maybe just link there).
  • "In our case, we use PyInstaller..." should be a note, I think (block quote).

@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-versioncmd-h5yeruw September 30, 2020 15:48 Inactive
@shcheklein shcheklein temporarily deployed to dvc-landing-versioncmd-h5yeruw October 1, 2020 18:58 Inactive
@imhardikj imhardikj requested a review from jorgeorpinel October 1, 2020 19:23
@shcheklein shcheklein temporarily deployed to dvc-landing-versioncmd-h5yeruw October 1, 2020 19:26 Inactive
Copy link
Contributor

@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.

Almost there (I hope).

  • A few grammar typos left which are worrying — I have to read everything very carefully to make sure the sentence articles are there which makes it harder to review your changes. Usually this is not something we have to worry about. Please pay 3x attention to this going forward.
  • The description of Development version needs a little more work, but that's the last of it.
  • I took care of another few things so this is closer to merge.

Thanks @imhardikj

Copy link
Contributor

@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.

Done! Just a couple small copy edits pending ☝️ (I may take care of them).

@jorgeorpinel jorgeorpinel merged commit 4775512 into master Oct 12, 2020
@jorgeorpinel
Copy link
Contributor

Thanks again @imhardikj, let's keep moving on the remaining cmd ref updates from v0 to v1. I'll keep the reviews more focused and create separate issues if deeper text reviews are needed.

@imhardikj imhardikj deleted the versioncmd branch October 13, 2020 18:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

cmd: update version ref.
4 participants