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

x/pkgsite: don't imply that vN.x.y is the latest version when vN+1 exists #37765

Open
cespare opened this issue Mar 9, 2020 · 2 comments
Open

x/pkgsite: don't imply that vN.x.y is the latest version when vN+1 exists #37765

cespare opened this issue Mar 9, 2020 · 2 comments

Comments

@cespare
Copy link
Contributor

@cespare cespare commented Mar 9, 2020

What is the URL of the page with the issue?

For example: https://pkg.go.dev/github.com/cespare/xxhash?tab=doc

What is your user agent?

N/A

Screenshot

screen_20200309145922

What did you do?

Viewed the v1 documentation for a module that also has a v2.

What did you expect to see?

No v1 version of my module should be marked as "Latest" since v2 exists.

What did you see instead?

v1.1.0 was marked as "Latest".

I understand that v1 and v2 are essentially two different modules, and that the discovery site is showing that v1.1.0 is the latest version of the v1 module. However, this may mislead users into thinking that v1.1.0 is somehow up-to-date. I do not want new users of my module to use v1.1.0; I want them to use the real latest version of the module which is v2.1.1 at the moment.

Ideally, when viewing v1.1.0, the users would see on the page that v2 exists and is the latest major module version. There ought to be a link to quickly go to the latest version, just as there is a red "Go to latest" link when viewing the not-latest-minor-version page (example):

screen_20200309150757

This is related to #36969, where the search ranking also pushes users toward using the old major version of my module.

Right now it seems that the discovery site has very little notion of the relationship between different major versions of the same module. Please consider how to make this site more friendly for maintainers of v2+ modules.

@gopherbot gopherbot added this to the Unreleased milestone Mar 9, 2020
@gopherbot gopherbot added the pkgsite label Mar 9, 2020
@julieqiu julieqiu added the UX label Mar 10, 2020
@julieqiu
Copy link
Contributor

@julieqiu julieqiu commented Mar 10, 2020

Thanks for the feedback! We understand that this is confusing and plan to fix it as part of an upcoming round of UX changes.

/cc @fflewddur

@bcmills
Copy link
Member

@bcmills bcmills commented Mar 10, 2020

I think there are two different notions of “latest” at play here.

One is “what is the latest implementation of this API?”, and for that notion, v1.1.0 is correct.

The other is “what is the latest variant of this API that addresses the same general use-cases?”, and that notion is better answered by v2.1.1.

It may be worthwhile to surface both of those answers in some fashion.

@julieqiu julieqiu changed the title go.dev: don't imply that vN.x.y is the latest version when vN+1 exists x/pkgsite: don't imply that vN.x.y is the latest version when vN+1 exists Jun 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
4 participants
You can’t perform that action at this time.