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: additional metadata in the right sidebar #43129

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
Assignees
Labels

Comments

@jamalc
Copy link
Member

@jamalc jamalc commented Dec 11, 2020

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.

@gopherbot
Copy link

@gopherbot gopherbot commented Dec 14, 2020

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

@gopherbot
Copy link

@gopherbot gopherbot commented Dec 14, 2020

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

@gopherbot
Copy link

@gopherbot gopherbot commented Dec 14, 2020

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
For golang/go#43129

Change-Id: I5b5231270efc298186e84444fc72241416888376
Reviewed-on: https://go-review.googlesource.com/c/pkgsite/+/277852
Trust: Jamal Carvalho <jamal@golang.org>
Run-TryBot: Jamal Carvalho <jamal@golang.org>
Reviewed-by: Julie Qiu <julie@golang.org>
TryBot-Result: kokoro <noreply+kokoro@google.com>
gopherbot pushed a commit to golang/pkgsite that referenced this issue Dec 14, 2020
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 <julie@golang.org>
Trust: Julie Qiu <julie@golang.org>
Trust: Jamal Carvalho <jamal@golang.org>
Run-TryBot: Julie Qiu <julie@golang.org>
TryBot-Result: kokoro <noreply+kokoro@google.com>
gopherbot pushed a commit to golang/pkgsite that referenced this issue Dec 14, 2020
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 <jamal@golang.org>
Reviewed-by: Julie Qiu <julie@golang.org>
@jamalc jamalc closed this Dec 15, 2020
@seh
Copy link
Contributor

@seh 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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants