patternfly / patternfly-quickstarts

Repository containing the PatternFly Quick Start extension code
MIT License
15 stars 38 forks source link

Add images to quick starts #207

Open jessiehuff opened 1 year ago

jessiehuff commented 1 year ago

Request to be able to add images into the Quickstart to show a user what they can expect in the UI. You can see what they’re thinking here (open to design suggestions, this is rough). https://docs.google.com/document/d/1TDjGowTdRhckomVZhC-yehQr_iywwmQt0FPiSkvgrjY/edit#heading=h.dmsnngmkdaf0

Requested by OpenShift/Matt Carleton

Potential design by Missy: https://sketch.com/s/e8e74051-20c1-4a7d-b22d-470c2fdd6cd6 Based on Lucia's comment, option A is preferred with the magnifier cursor opening the image in a modal. Also suggested is 16px padding on the top/bottom of an image so that it has a bit more breathing room around the surrounding text.

jessiehuff commented 1 year ago

We've talked about this idea in a few QS working group meetings. Some of the downsides include the need for maintenance. If the UI changes, products will need to remember to update the images in the quick start. It might make more sense for products to use UI highlighting instead (Michael Celedonia's UI highlighting design):

Image

It's also worth noting that this would require design insight into when to use images appropriately.