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

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

x/pkgsite: redesign - umbrella issue #41585

julieqiu opened this issue Sep 23, 2020 · 3 comments
Labels
NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. pkgsite umbrella

Comments

@julieqiu
Copy link
Contributor

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. x/pkgsite: redesign - the pkg.go.dev/<path> page #41586: the pkg.go.dev/<path> page
  2. x/pkgsite: redesign - the documentation section #41587: the documentation section
  3. x/pkgsite: redesign - surfacing “latest” #41588: surfacing “latest”
  4. x/pkgsite: support custom links #42968: support custom links
  5. x/pkgsite: additional metadata in the right sidebar #43129: additional metadata in the right sidebar

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:

Package page lacks potentially useful information:

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

Search page

Search results are noisy:

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

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.

@gopherbot gopherbot added this to the Unreleased milestone 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
@julieqiu julieqiu added the NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. label Sep 23, 2020
@golang golang locked as resolved and limited conversation to collaborators Sep 23, 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
@julieqiu
Copy link
Contributor Author

julieqiu commented Oct 28, 2020

A preview of the redesign is now available on beta.pkg.go.dev! Give it a try, and please file an issue for any bugs!

If you’d like to run the beta site locally, you can do so using these steps:

  1. git clone https://go.googlesource.com/pkgsite
  2. go run devtools/cmd/create_experiment_config/main.go
  3. Set GO_DISCOVERY_CONFIG_DYNAMIC to the output of that script.
  4. Follow instructions at doc/frontend.md to run the frontend.
  5. Visit localhost:8080/<your-package>.

@julieqiu
Copy link
Contributor Author

julieqiu commented Nov 10, 2020

The redesign of the pkg.go.dev/<path> page is now live on https://pkg.go.dev!

Check out the blog post for details.

As always, please file an issue for any feedback or bugs!

@julieqiu
Copy link
Contributor Author

julieqiu commented Dec 15, 2020

Closing this issue, since the redesign of the pkg.go.dev/<path> page and issues at https://github.com/golang/go/milestone/159 are completed.

We plan to revisit the search page in 2021. Issues are being tracked at https://github.com/golang/go/milestone/164.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. pkgsite umbrella
Projects
None yet
Development

No branches or pull requests

2 participants