Point docs link to v4
#524
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It's very confusing that when I land directly on `https://pkg.go.dev/github.com/golang-migrate/migrate` I get a the message: > You are look at a deprecated version, use the latest version instead But when I click the `latest version` link, it goes to a completely dead/wrong place. So I think for almost anyone who actually wants to look at the real docs, it's a lot simpler to link straight to `v4` by default. If they want a different version, they can change that. But let's have the default point to a helpful place, and then you can go looking for the broken version, rather than the other way around.
dhui
requested changes
Mar 13, 2021
README.md
Outdated
| @@ -1,5 +1,5 @@ | |||
| [](https://circleci.com/gh/golang-migrate/migrate) | |||
| [](https://godoc.org/github.com/golang-migrate/migrate) | |||
| [](https://pkg.go.dev/github.com/golang-migrate/migrate/v4) | |||
There was a problem hiding this comment.
Ah, didn't realize they now exposed those directly... updated! I used the Github web UI which doesn't allow squashing, so please squash on merge.
I dropped the ?status.svg as it appears to work fine without that, but if you want me to put it back let me know.
I also wasn't sure if I needed to append /v4 to the end of the image URL... it looks the same both ways, so I thought simpler to leave w/o so that if there's ever a v5 only the actual link needs updating, not the image link.
dhui
approved these changes
Mar 14, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It's very confusing that when I land directly on
https://pkg.go.dev/github.com/golang-migrate/migrateI get a the message:But when I click the
latest versionlink, it goes to a completely dead/wrong place.So I think for almost anyone who actually wants to look at the real docs, it's a lot simpler to link straight to
v4by default. If they want a different version, they can change that. But let's have the default point to a helpful place, and then you can go looking for the broken version, rather than the other way around.