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

static-badge-builder documentation is totally confusing for a newbie #9545

Closed
zola-25 opened this issue Sep 2, 2023 · 1 comment
Closed

Comments

@zola-25
Copy link

zola-25 commented Sep 2, 2023

📋 Documentation confusing.

'style': One of: flat (default), flat-square, plastic, for-the-badge, social

What do these mean?

'label string'

'Override the default left-hand-side text (URL-Encoding needed for spaces or special characters!)'

Except 'build status' with a whitespace character works fine, adding special characters just prints them encoded.

'badge-content', after just removing the label string, works with a hyphenated (unescaped)-color. So no html escaping on needed input there either?

Finally, 'Static Badge builder' implies it builds static content, like an SVG. But it just creates another URL, whatever format you choose. So there's not much more particularly 'static' about it.

None of this would matter if there were other links in the document explaining these parameters, but there aren't.

Sorry if I sound blunt, I'm just being clear, a very frustrating experience that left me looking at other options.

@calebcartwright
Copy link
Member

Thanks for reaching out but I'm going to close as this strikes me as a sharing of an opinion/experience vs. any specific action item.

In general, I'd note:

What do these mean?

Not entirely clear what this is asking. Shields supports several different styles of badges, users can choose which style they want for any given badge, and the style parameter is how one specifies their desired style. Are you asking for a textual description of those individual styles?

So no html escaping on needed input there either?

Very unclear what you're asking or even referring to here given the preceding text.

Finally, 'Static Badge builder' implies it builds static content, like an SVG.

It does. the URL is how you access the SVG. Shields serves up badges, primarily as SVGs, and those badges are accessed via specific url routes; the badge builder in the UX exists to help folks figure out the url they need to get the badge they want.


I'm unsure how to help/respond to any other aspects in the description as they come across as more of an unstructured criticism as opposed to specific questions/seeking more information. Feel free to ask any follow up questions either here and/or Discord if you prefer.

@calebcartwright calebcartwright closed this as not planned Won't fix, can't repro, duplicate, stale Sep 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants