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

Jump to bottom

x/pkgsite: documentation for gardener/oidc-webhook-authenticator not displayed #50001

Closed
msohn opened this issue Dec 6, 2021 · 2 comments
Closed

x/pkgsite: documentation for gardener/oidc-webhook-authenticator not displayed #50001

msohn opened this issue Dec 6, 2021 · 2 comments
Labels
FrozenDueToAge NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. pkgsite/license Issues related to licenses on pkg.go.dev. See our license policy https://pkg.go.dev/license-policy pkgsite
Milestone
pkgsite/license

Comments

@msohn
Copy link

msohn commented Dec 6, 2021

What is the URL of the page with the issue?

https://pkg.go.dev/github.com/gardener/oidc-webhook-authenticator@v0.5.0/apis/authentication/v1alpha1

What is your user agent?

Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/96.0.4664.55 Safari/537.36

Screenshot

Screenshot 2021-12-06 at 17 14 00

What did you do?

open https://pkg.go.dev/github.com/gardener/oidc-webhook-authenticator@v0.5.0/apis/authentication/v1alpha1 in a browser

What did you expect to see?

The API documentation of this component

What did you see instead?

Documentation not displayed due to license restrictions.
See our license policy.

Note that we follow REUSE to declare license and copyright.
Hence license texts are located in the folder LICENSES, in addition we symlinked the main license (Apache-2.0) of the component to ./LICENSE
Find the source code repository here https://github.com/gardener/oidc-webhook-authenticator
@gopherbot gopherbot added this to the pkgsite/unplanned milestone Dec 6, 2021
@jamalc jamalc added the NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. label Dec 10, 2021
@jamalc
Copy link

jamalc commented Jan 31, 2022

/cc @jba

@jba
Copy link
Contributor

jba commented Feb 1, 2022 •
edited

We look only in the root directory for licenses, not in a LICENSES (or any other) subdirectory.

That leaves the symlink. Since we read the zips served to us by the proxy (and ultimately created by go mod download), and those don't preserve symlinks, we don't see a LICENSE file.

I suggest copying the file to LICENSE instead of symlinking it.

@jba jba closed this as completed Feb 1, 2022
@hyangah hyangah added the pkgsite/license Issues related to licenses on pkg.go.dev. See our license policy https://pkg.go.dev/license-policy label May 20, 2022
@zeroshade zeroshade mentioned this issue Mar 9, 2023
Merged
@golang golang locked and limited conversation to collaborators May 20, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
FrozenDueToAge NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. pkgsite/license Issues related to licenses on pkg.go.dev. See our license policy https://pkg.go.dev/license-policy pkgsite
Projects
None yet
Milestone
pkgsite/license
Development

No branches or pull requests
5 participants
@msohn @hyangah @gopherbot @jamalc @jba