We chose to label the input "URL" to clarify that the tool is not limited to packages. The form does accept full URLs but the schema and host are trimmed from the input box once they are submitted. On second look that may be somewhat misleading.
It could be a better experience to keep the full URL in the input box after the badge is created OR to label the input something like Path and clarify that it can be any pkg.go.dev URL path and is not limited to packages. I think in any case we should accept full URL or a pkg.go.dev path as input.
jamalc
added
help wanted
NeedsFix
The path to resolution is known, but the work has not been done.
and removed
NeedsInvestigation
Someone must examine and confirm this is a valid issue and not a duplicate of an existing one.
labels
Jul 17, 2020
julieqiu
changed the title
x/pkgsite: Generator field is called URL but expect an package name
x/pkgsite: clarify expected input on pkg.go.dev/badge
Jul 29, 2020
What is the URL of the page with the issue?
https://pkg.go.dev/badge/
What is your user agent?
Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Firefox/78.0
Screenshot
What did you do?
Open the page.
What did you expect to see?
The form-field called
URL
should either be calledpackage
or accept an URL with an (https-)schema.What did you see instead?
The Form-Field is called URL, but if you paste an URL with an protocol-schema, it creates an invalid link to pkg.go.dev.
The example text in the empty form-field (when empty) shows an example URL with an schema. This example creates an invalid badge.
I already reported it here but was ask to create a new issue.
The text was updated successfully, but these errors were encountered: