-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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
Mention v2
first
#927
Conversation
Codecov Report
@@ 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.
|
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.
Don't know what version you're on? You're probably using the version from the
master
branch, which is currentlyv2
.
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.
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.
LGTM
Co-Authored-By: Sascha Grunert <mail@saschagrunert.de>
7739b8c
|
||
### GOPATH | ||
**Warning**: `v2` is in a beta state. |
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 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.
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'll think on the wording here for a bit, and stand up a PR for changing this line 👍
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 usingv2
.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.