search

FRosner / cluster-broccoli

Self service for Nomad based on templates.
Apache License 2.0
60 stars 22 forks source link

Show parameter types in front-end #361

Closed FRosner closed 6 years ago

FRosner commented 6 years ago

I think it's good to somehow show the parameter type in the front-end. Otherwise the user has to guess whether he has to enter a number or a string, e.g.

I'm not sure about the visuals. It looks a bit clumsy like this. @sohaibiftikhar what do you think? What do the others think?

image

image

fixes #365

sohaibiftikhar commented 6 years ago

Seems okay. But what happens when we start using more complex types? Say for example Regex/Lists/Sets/Ports etc. Finding icons might get harder. Maybe just the tooltip is enough? Since we'd have more flexibility with strings.

FRosner commented 6 years ago

Finding icons might get harder. Maybe just the tooltip is enough? Since we'd have more flexibility with strings.

I agree that it might get harder to find icons. On the other hand icons are more intuitive and smaller. If there is no icon available we might as well design one. A tooltip alone is not so nice as it takes some time to load, is not obvious, and not available on mobile.

Despite the fact that we need to have icons for all the upcoming types, what do you say about the ones I chose and the way it is displayed?

sohaibiftikhar commented 6 years ago

If there is no icon available we might as well design one

Well if we do that we may need to design it for all types otherwise the design won't be consistent across types. Generally speaking I would prefer to avoid this.

About intuitiveness we are basically looking at icons thinking this image may represent type T. Looking at a hash for example a user could conclude that it is a number but does not really know that the number must be an integer (so there is still doubt). And for the decimal the '5.1' sign may be standardized for something else (sound 5.1). For someone who already knows what it is generally used for, it might even become confusing to see it here. What I mean to say is that the icons are not a value add in every case. They work for simple forms but the forms in Broccoli are a bit more 'technical'. Plus it is hard to maintain because of the designing thing.

As for the design itself I think it is good. Does not change too much of what was being done earlier and even though it occupies a tad more space than I would prefer it is still acceptable.

FRosner commented 6 years ago

@sohaibiftikhar can you please review again?

sohaibiftikhar commented 6 years ago

LGTM