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: standard library packages are not discoverable #40785

Closed
penmanglewood opened this issue Aug 14, 2020 · 11 comments
Closed

x/pkgsite: standard library packages are not discoverable #40785

penmanglewood opened this issue Aug 14, 2020 · 11 comments
Labels
NeedsDecision pkgsite UX

Comments

@penmanglewood
Copy link

@penmanglewood penmanglewood commented Aug 14, 2020

What is the URL of the page with the issue?

https://pkg.go.dev/

What is your user agent?

Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0 Safari/605.1.15

Screenshot

Screen Shot 2020-08-14 at 3 29 13 PM

What did you do?

I clicked on "Discover Packages".

What did you expect to see?

I expected to have the ability to discover packages, especially from the standard library, as the link promises.
On https://golang.org/pkg/, I am able to see at a glance the entire standard library and discover new packages I haven't used before.

What did you see instead?

Instead, I see a search bar. This indicates that I need to already know what I'm looking for.

@gopherbot gopherbot added this to the Unreleased milestone Aug 14, 2020
@dmitshur dmitshur changed the title x/pkgsite: Standard library packages are not discoverable x/pkgsite: standard library packages are not discoverable Aug 17, 2020
@dmitshur
Copy link
Contributor

@dmitshur dmitshur commented Aug 17, 2020

On https://golang.org/pkg/, only the packages from the standard library are included, so it is viable to list every single package in an exhaustive list on the front page. On https://pkg.go.dev, there are many more packages that can be discovered, so exhaustively listing them all on the front page is not viable.

Do you think something else can be done? Or is your suggestion to make it easier to understand how to find a list of packages that are only in the standard library?

One more question. Are you already aware of the https://pkg.go.dev/std page, which has a "Packages" tab that lists all packages? I'm asking because if you weren't aware of it, it's possible that making that page more discoverable can be a way to improve the situation.

/cc @julieqiu @jba @jamalc per owners.

@dmitshur dmitshur added NeedsInvestigation pkgsite labels Aug 17, 2020
@julieqiu julieqiu added WaitingForInfo and removed NeedsInvestigation labels Aug 17, 2020
@penmanglewood
Copy link
Author

@penmanglewood penmanglewood commented Aug 27, 2020

Do you think something else can be done? Or is your suggestion to make it easier to understand how to find a list of packages that are only in the standard library?

Yes I was suggesting making it easier to discover standard library packages without needing to know about their existence in the first place.

https://godoc.org lists the top 25 packages by popularity and has links to the standard library, golang.org/x packages, and various search filters on Github. This level of discoverability is nice, in my humble opinion.

Given that a flash message on https://godoc.org is currently offering to "Always use pkg.go.dev" instead of godoc.org, it would be great to keep this level of discoverability in the new offering.

@julieqiu julieqiu removed this from the Unreleased milestone Aug 27, 2020
@julieqiu julieqiu added this to the pkgsite/unreleased milestone Aug 27, 2020
@penmanglewood
Copy link
Author

@penmanglewood penmanglewood commented Aug 28, 2020

One more question. Are you already aware of the https://pkg.go.dev/std page, which has a "Packages" tab that lists all packages? I'm asking because if you weren't aware of it, it's possible that making that page more discoverable can be a way to improve the situation.

I wasn't aware of this page. Thank you for pointing it out.

For the purposes of making this issue actionable, I second your suggestion of linking to https://pkg.go.dev/std from the "Discover Packages" page.

@ALTree ALTree added NeedsDecision and removed WaitingForInfo labels Jun 18, 2021
@themowski
Copy link

@themowski themowski commented Sep 14, 2021

I'd like to give a strong +1 for this issue. I would really like to see the standard library documentation explicitly linked somewhere instead of hidden behind the search functionality.

Right now, my solution to this problem is having a bookmark that takes me to https://pkg.go.dev/std -- but I'm an experienced Go user, and I knew that that was what I was looking for, and that it's the standard library documentation. From the perspective of a new user of any language, I like to know what packages are available in the standard library, and right now that information is not intuitive to find on pkg.go.dev at all.

In addition to the proposed option of adding some kind of link to the main "Discover" page, I would also recommend adding a "Standard Library" link under "Packages" in the page footer (where the red box is in this screenshot):

image

While putting the link in the footer isn't ideal, it would be a lot better than not having it anywhere, and I'm honestly surprised every time I go to pkg.go.dev without using my standard library bookmark that it's not there already.

@julieqiu
Copy link
Contributor

@julieqiu julieqiu commented Sep 14, 2021

/cc @jinhongy @fflewddur for UX input

@julieqiu julieqiu added the UX label Sep 14, 2021
@jinhongy
Copy link

@jinhongy jinhongy commented Sep 14, 2021

Thanks for the feedback. We are in the process of unifying the experience for golang.org and go.dev, with the new design, we will include the standard library link on the secondary navigation on top, which I think will solve this issue.

@fzipp
Copy link
Contributor

@fzipp fzipp commented Nov 22, 2021

The new unified experience was launched today, but there still doesn't seem to be a link to the standard library overview https://pkg.go.dev/std in the navigation.

@gopherbot
Copy link

@gopherbot gopherbot commented Nov 24, 2021

Change https://golang.org/cl/366577 mentions this issue: _content: adjust footer

@ALTree ALTree mentioned this issue Nov 29, 2021
gopherbot pushed a commit to golang/website that referenced this issue Nov 30, 2021
Change footer About heading to link to /project.
Linking to /about was always mainly about pkg.go.dev,
and now it redirects to pkg.go.dev/about, so that's clearly wrong.
But we need a link to somewhere, and we also need a link to /project
(which used to a be a top-level heading on golang.org),
so it's a good match.

Add Standard Library to Packages section.

Add Help to Get Started section.
(Used to be a top-level heading on golang.org.)

For golang/go#40785 (but probably more to do there).
Fixes golang/go#49737.
Fixes golang/go#49768.

Change-Id: I4a0837aaaa89b3bd79bda7a55bcff3a5ef9e206b
Reviewed-on: https://go-review.googlesource.com/c/website/+/366577
Trust: Russ Cox <rsc@golang.org>
Run-TryBot: Russ Cox <rsc@golang.org>
TryBot-Result: Go Bot <gobot@golang.org>
Reviewed-by: Jamal Carvalho <jamal@golang.org>
@seankhliao
Copy link
Member

@seankhliao seankhliao commented Dec 3, 2021

The updated footer seems to only affect go.dev but not pkg.go.dev?

@gopherbot
Copy link

@gopherbot gopherbot commented Dec 10, 2021

Change https://golang.org/cl/370994 mentions this issue: static/shared: adjust footer

gopherbot pushed a commit to golang/pkgsite that referenced this issue Dec 13, 2021
- Updated footer to match changes made to go.dev in CL 366577.
- Replaced golang.org links with go.dev links.

For golang/go#40785

Change-Id: Ieb342fa5e9528642744faaab692e4244824e8857
Reviewed-on: https://go-review.googlesource.com/c/pkgsite/+/370994
Trust: Jamal Carvalho <jamal@golang.org>
Run-TryBot: Jamal Carvalho <jamal@golang.org>
Reviewed-by: Jonathan Amsterdam <jba@google.com>
Reviewed-by: Julie Qiu <julie@golang.org>
@seankhliao
Copy link
Member

@seankhliao seankhliao commented Jun 7, 2022

Closing as done

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
NeedsDecision pkgsite UX
Projects
None yet
Development

No branches or pull requests

10 participants