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

Mention v2 first #927

Merged
merged 2 commits into from Nov 15, 2019
Merged

Mention v2 first #927

merged 2 commits into from Nov 15, 2019

Conversation

coilysiren
Copy link
Member

Surfaced via @skillful-alex here #925 (comment), people reading the documentation are under the impression that they should be reading the v1 documentation, when they should instead be using v2.

This PR changes the readme to mention the v2 documentation first, and adds a "if you don't know, you're probably using v2" mention.

@coilysiren coilysiren requested a review from a team as a code owner November 13, 2019 22:05
@coilysiren coilysiren self-assigned this Nov 13, 2019
@codecov
Copy link

codecov bot commented Nov 13, 2019

Codecov Report

Merging #927 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #927   +/-   ##
=======================================
  Coverage   72.89%   72.89%           
=======================================
  Files          32       32           
  Lines        2439     2439           
=======================================
  Hits         1778     1778           
  Misses        550      550           
  Partials      111      111

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f6f1ac6...7739b8c. Read the comment docs.

xordspar0
xordspar0 previously approved these changes Nov 14, 2019
Copy link
Contributor

@xordspar0 xordspar0 left a comment

Choose a reason for hiding this comment

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

Don't know what version you're on? You're probably using the version from the master branch, which is currently v2.

This is the most helpful part to me. I've known about the (previously dormant) v2 branch for a while, but it's good to know that this is the master branch.

saschagrunert
saschagrunert previously approved these changes Nov 14, 2019
Copy link
Member

@saschagrunert saschagrunert left a comment

Choose a reason for hiding this comment

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

LGTM

README.md Outdated Show resolved Hide resolved
asahasrabuddhe
asahasrabuddhe previously approved these changes Nov 14, 2019
Co-Authored-By: Sascha Grunert <mail@saschagrunert.de>

### GOPATH
**Warning**: `v2` is in a beta state.
Copy link
Contributor

Choose a reason for hiding this comment

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

I guess it's not really a beta, but rather early days, as beta implies that people should use v1 for something stable, which I don't think is what we want.

Copy link
Member Author

Choose a reason for hiding this comment

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

I'll think on the wording here for a bit, and stand up a PR for changing this line 👍

@coilysiren coilysiren merged commit c443515 into master Nov 15, 2019
@coilysiren coilysiren deleted the lynncyrin-patch-2 branch November 21, 2019 09:10
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.

None yet

5 participants