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: redesign - umbrella issue #41585

Open
julieqiu opened this issue Sep 23, 2020 · 0 comments
Open

x/pkgsite: redesign - umbrella issue #41585

julieqiu opened this issue Sep 23, 2020 · 0 comments

Comments

@julieqiu
Copy link
Contributor

@julieqiu julieqiu commented Sep 23, 2020

This is the umbrella issue for an upcoming redesign of pkg.go.dev. Specific plans will be shared via a series of additional issues:

  1. #41586: the pkg.go.dev/<path> page
  2. #41587: the documentation section
  3. #41588: surfacing “latest”

More to come!

Milestone: pkgsite/design-2020

Background

Pkg.go.dev is a site for developers to discover and evaluate Go packages and modules, and have the information they need to decide whether they want to integrate these packages into their codebase. Like godoc.org, pkg.go.dev serves Go documentation, but it also provides information about past versions of packages. Eventually, traffic from godoc.org will be redirected to the corresponding page on pkg.go.dev.

A Go repository can contain several Go modules, each of which has its own packages. The way this information is organized on pkg.go.dev today makes it confusing to users how packages, modules, different major versions, and repositories are related to each other.

Based on feedback, the general themes are:

pkg.go.dev/<path> page

The /mod/ pages are not surfacing useful information:

  • #36791: modules with no package at the root directory are shown awkwardly
  • #38087: rethink module page

Package page lacks potentially useful information:

  • #39218: add repository link on documentation page
  • #38513: show README of subpackage in overview tab
  • #38596: subdirectories are missing for nested modules
  • #41278: add option to refresh a package on the package page
  • #38514: provide multiple "copy to clipboard" options
  • #37912: add import / imported by count

The “latest” version for a pkg.go.dev/<path> pages can be confusing:

  • #37631: flag packages that are no longer present in the latest version of the containing module
  • #39244: /<path> should show the contents for the latest version of the containing module
  • #41032: multi-module projects have confusing versions
  • #41345: new major version not surfaced when it does not yet have a release tag
  • #37714 (recently fixed): latest version should not be +incompatible
  • #37765 (recently fixed): don't imply that vN.x.y is the latest version when vN+1 exists (also mentioned in #40323)

Search page

Search results are noisy:

  • #37788: do not show packages of a module at the top level
  • #36814: searching for modules isn't supported
  • #39525: searching for "youtube" only show results for github.com/youtube/vitess

The “latest” version for a search result can be confusing:

  • #36969: search ranking ought to prioritize more recent major module versions (also #41108)
  • #41108: search results show incorrect latest version if the latest version of the module and package do not match
  • #36806 (comment): rank the newest version of a module in a series of modules, higher than older ones:

Next

We plan to redesign pkg.go.dev to address these issues, with the goal of providing a better user experience on pkg.go.dev. These plans will be shared via a series of issues for discussion. Work for this milestone will be tracked at pkgsite/design-2020.

@julieqiu julieqiu closed this Sep 23, 2020
@gopherbot gopherbot added this to the Unreleased milestone Sep 23, 2020
@julieqiu julieqiu added the pkgsite label Sep 23, 2020
@julieqiu julieqiu changed the title x/pkgiste: <this issue is a placeholder for a future issue> x/pkgsite: redesign - tracking issue Sep 23, 2020
@julieqiu julieqiu reopened this Sep 23, 2020
@golang golang locked as resolved and limited conversation to collaborators Sep 23, 2020
@julieqiu julieqiu added the umbrella label Sep 24, 2020
@julieqiu julieqiu changed the title x/pkgsite: redesign - tracking issue x/pkgsite: umbrella issue for pkg.go.dev redesign Sep 24, 2020
@julieqiu julieqiu changed the title x/pkgsite: umbrella issue for pkg.go.dev redesign x/pkgsite: redesign - umbrella issue Sep 24, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

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