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

x/pkgsite: clarify expected input on pkg.go.dev/badge #40258

Open
ostcar opened this issue Jul 16, 2020 · 3 comments
Open

x/pkgsite: clarify expected input on pkg.go.dev/badge #40258

ostcar opened this issue Jul 16, 2020 · 3 comments

Comments

@ostcar
Copy link

@ostcar ostcar commented Jul 16, 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

screenshot

What did you do?

Open the page.

What did you expect to see?

The form-field called URL should either be called package 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.

@julieqiu
Copy link
Contributor

@julieqiu julieqiu commented Jul 17, 2020

/cc @jamalc

@jamalc
Copy link
Member

@jamalc jamalc commented Jul 17, 2020

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.

@julieqiu 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
@gopherbot
Copy link

@gopherbot gopherbot commented Aug 5, 2020

Change https://golang.org/cl/246318 mentions this issue: gollvm: update cmakelists to import correct c file

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
5 participants
You can’t perform that action at this time.