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

Jump to bottom

x/pkgsite: redesign - surfacing “latest” #41588

Closed
julieqiu opened this issue Sep 23, 2020 · 3 comments
Closed

x/pkgsite: redesign - surfacing “latest” #41588

julieqiu opened this issue Sep 23, 2020 · 3 comments
Labels
FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done. pkgsite
Milestone
pkgsite/godoc.org...

Comments

@julieqiu
Copy link
Member

julieqiu commented Sep 23, 2020 •
edited

We'll be redesigning pkg.go.dev based on feedback received over the last year. This is the third in a series of issues about plans for the pkgsite/design-2020 milestone. Comment below with any feedback or suggestions related to this issue!

Overview

There are multiple ways in which “latest” can be defined for a path. In order to better express various relationships, we will use the following terms:

  • Series: 1 or more modules that are major versions of each other
  • Project: 1 or more modules that share the same path prefix
  • Latest minor version: the latest minor version of a module containing a path, according to the cmd/go definition. This is also referred to as the “latest” or “@latest” version.
  • Latest major version: the latest major version in a module series.
    • If the latest major version does not have any tagged versions, but an earlier version does, pkg.go.dev will default to the earlier version as the “latest” major version.

Design

Pkg.go.dev will continue to use the following:

  • A “Latest” badge to indicate whether a user is viewing the latest minor version
  • A banner to indicate when a user is not viewing the latest major version

image

Note: This image is a mock, so the data may not accurately represent the exact contents of this package.

We plan to also use the banner style to indicate other information related to surfacing the “latest” version, such as when a path is not present in the latest version of the module.

If a path exists in the latest version of a module, pkg.go.dev/<path> will always show the contents for the latest version of the containing module.

Related Issues
@gopherbot gopherbot added this to the Unreleased milestone Sep 23, 2020
@julieqiu julieqiu mentioned this issue Sep 23, 2020
Closed
@julieqiu julieqiu changed the title x/pkgsite: <this issue is a placeholder for a future issue> x/pkgsite: redesign - surfacing “latest” Sep 23, 2020
@julieqiu julieqiu reopened this Sep 23, 2020
@julieqiu julieqiu added the NeedsFix The path to resolution is known, but the work has not been done. label Sep 23, 2020
@mvdan
Copy link
Member

mvdan commented Oct 29, 2020

@julieqiu I really like the new beta design, thank you for the work! I think I found a bug with this feature; when I navigate to https://beta.pkg.go.dev/mvdan.cc/sh/syntax, clicking on "The highest tagged major version is v3." takes me to https://beta.pkg.go.dev/mvdan.cc/sh/v3, not https://beta.pkg.go.dev/mvdan.cc/sh/v3/syntax.

I guess this is fine as a fallback, if v3/syntax doesn't exist as a package. But if the same sub-package exists in the new major version of the module, I think we should directly link there. Otherwise I have to go into "directories" and find it again.

@julieqiu
Copy link
Member Author

Thanks, @mvdan! That's a great suggestion. Would you mind filing a new issue for it?

@mvdan mvdan mentioned this issue Oct 30, 2020
Closed
@julieqiu
Copy link
Member Author

These changes are live on pkg.go.dev, and all related issues have been addressed except flag packages that are no longer present in the latest version of the containing module, which is tracked at #37631.

Closing this issue.

@golang golang locked and limited conversation to collaborators Jan 13, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done. pkgsite
Projects
None yet
Milestone
pkgsite/godoc.org-redirect
Development

No branches or pull requests
3 participants
@mvdan @julieqiu @gopherbot