Skip to content

x/pkgsite: additional metadata in the right sidebar #43129

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.

Sign up for GitHub

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
Closed
jamalc opened this issue Dec 11, 2020 · 4 comments
Closed

x/pkgsite: additional metadata in the right sidebar #43129

jamalc opened this issue Dec 11, 2020 · 4 comments
Labels
FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done. pkgsite
Milestone
pkgsite/design-2020

Comments

@jamalc
Copy link

jamalc commented Dec 11, 2020 •
edited
Loading

We want to surface useful information to Go users and help reinforce best practices for maintaining packages on pkg.go.dev. To do so, we plan to highlight the following metadata:

This information will be displayed in the right sidebar in the order listed above. A toggle tip will explain in more detail what each item represents.

Meets all best practices
Screen Shot 2020-12-10 at 4 25 39 PM

Meets no best practices
Screen Shot 2020-12-10 at 5 50 25 PM

This set of data is not an exhaustive representation of best practices but will provide a good foundation for one and should evolve over time to include information about things like popularity, code quality, and code stability.
@jamalc jamalc added NeedsFix The path to resolution is known, but the work has not been done. pkgsite labels Dec 11, 2020
@jamalc jamalc added this to the pkgsite/design-2020 milestone Dec 11, 2020
@jamalc jamalc self-assigned this Dec 11, 2020
@julieqiu julieqiu mentioned this issue Dec 11, 2020
Closed
@gopherbot
Copy link
Contributor

Change https://golang.org/cl/277832 mentions this issue: internal: add fields to unit meta struct

@gopherbot
Copy link
Contributor

Change https://golang.org/cl/277852 mentions this issue: content/static: add new svg icons for sidebar details section

@gopherbot
Copy link
Contributor

Change https://golang.org/cl/277854 mentions this issue: content/static: additional metadata in the right sidebar

gopherbot pushed a commit to golang/pkgsite that referenced this issue Dec 14, 2020
@jamalc
content/static: add new svg icons for sidebar details section
1556c6b 
For golang/go#43129

Change-Id: I5b5231270efc298186e84444fc72241416888376
Reviewed-on: https://go-review.googlesource.com/c/pkgsite/+/277852
Trust: Jamal Carvalho <[email protected]>
Run-TryBot: Jamal Carvalho <[email protected]>
Reviewed-by: Julie Qiu <[email protected]>
TryBot-Result: kokoro <[email protected]>
gopherbot pushed a commit to golang/pkgsite that referenced this issue Dec 14, 2020
@jamalc
internal: add fields to unit meta struct
4e306af 
Adds HasGoMod and VersionType fields to the UnitMeta struct
and ModFileURL and IsStableVersion to UnitMain to support the
details section in the right sidebar.

For golang/go#43129

Change-Id: Id605d27d6a421d7c5ff2afc39f4532b11e49ace6
Reviewed-on: https://go-review.googlesource.com/c/pkgsite/+/277832
Reviewed-by: Julie Qiu <[email protected]>
Trust: Julie Qiu <[email protected]>
Trust: Jamal Carvalho <[email protected]>
Run-TryBot: Julie Qiu <[email protected]>
TryBot-Result: kokoro <[email protected]>
gopherbot pushed a commit to golang/pkgsite that referenced this issue Dec 14, 2020
@jamalc
content/static: additional metadata in the right sidebar
69dd229 
Adds a section to the right sidenav highlighting
metadata about modules to help reinforce best practices
for maintaining modules on the pkgsite. This feature is
implemented behind the "unit-meta-details" experiment.

For golang/go#43129

Change-Id: I2755756b10f5cb1b1d1a2f9caf42c90fc715ff3b
Reviewed-on: https://go-review.googlesource.com/c/pkgsite/+/277854
Trust: Jamal Carvalho <[email protected]>
Reviewed-by: Julie Qiu <[email protected]>
@jamalc jamalc closed this as completed Dec 15, 2020
@seh
Copy link
Contributor

seh commented Dec 15, 2020

These details are not visible in a browser window not deemed to be sufficiently wide—in my case, about 885 pixels. Can we display these details elsewhere, such as at the bottom of the page if it's too narrow?

@golang golang locked and limited conversation to collaborators Dec 15, 2021
@rsc rsc unassigned jamalc Jun 23, 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/design-2020
Development

No branches or pull requests
3 participants
@seh @gopherbot @jamalc