Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.Sign up
x/pkgsite: clarify expected input on pkg.go.dev/badge #40258
What is the URL of the page with the issue?
What is your user agent?
Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Firefox/78.0
What did you do?
Open the page.
What did you expect to see?
The form-field called
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.
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.