Skip to content

x/pkgsite: add "Package files" section for commands #41396

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
LeGEC opened this issue Sep 15, 2020 · 2 comments
Closed

x/pkgsite: add "Package files" section for commands #41396

LeGEC opened this issue Sep 15, 2020 · 2 comments
Labels
FeatureRequest Issues asking for a new feature that does not need a proposal. FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done. pkgsite
Milestone
pkgsite/design-2020

Comments

@LeGEC
Copy link

LeGEC commented Sep 15, 2020

What is the URL of the page with the issue?

https://pkg.go.dev/github.com/google/gopacket/examples/httpassembly?tab=doc

What is your user agent?

Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:80.0) Gecko/20100101 Firefox/80.0

Screenshot

not relevant

What did you do?

Just went to the doc page for this package

What did you expect to see?

A Package files section, with links to the underlying code files, as the former godoc.org site would offer :

https://godoc.org/github.com/google/gopacket/examples/httpassembly?tab=doc
has a main.go link, which leads to :
https://github.com/google/gopacket/blob/master/examples/httpassembly/main.go

What did you see instead?

I found no such link, in none of the tabs of the pkg.go.dev version for this url.

In this specific case, there is no public symbol to "document", and the documentation clearly implies "go read the code of the main function", so the lack of Package files section is particularly emphasized here.
@gopherbot gopherbot added this to the Unreleased milestone Sep 15, 2020
@toothrot toothrot added website NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. labels Sep 15, 2020
@julieqiu julieqiu added pkgsite and removed website labels Sep 19, 2020
@julieqiu julieqiu removed the website label Sep 19, 2020
@jba
Copy link
Contributor

jba commented Sep 19, 2020

We'll be adding a Package Files section soon.

@jba jba modified the milestones: Unreleased, pkgsite/design-2020 Sep 19, 2020
@jba jba added NeedsFix The path to resolution is known, but the work has not been done. FeatureRequest Issues asking for a new feature that does not need a proposal. and removed NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. labels Sep 19, 2020
@julieqiu julieqiu changed the title x/pkgsite: no 'Package files' links x/pkgsite: add "Package files" section for commands Sep 21, 2020
@julieqiu
Copy link
Member

This feature is now available on beta.pkg.go.dev. See #41585 (comment) for details, and https://beta.pkg.go.dev/github.com/google/gopacket/examples/httpassembly#section-sourcefiles as an example.

Closing this issue for #41586.

@golang golang locked and limited conversation to collaborators Oct 29, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
FeatureRequest Issues asking for a new feature that does not need a proposal. 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
5 participants
@toothrot @LeGEC @julieqiu @gopherbot @jba