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

[msohn]

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

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

[jamalc]

/cc @jba

[jba]

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.