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

Visual Distinction between Preview Connector types #3201

Closed
sjcox-rh opened this issue Jul 26, 2018 · 16 comments · Fixed by #3242
Closed

Visual Distinction between Preview Connector types #3201

sjcox-rh opened this issue Jul 26, 2018 · 16 comments · Fixed by #3242
Assignees
Labels
cat/design concrete UX design. Use this for PRs containing UX designs. cat/feature PR label for a new feature group/ui User interface SPA, talking to the REST backend group/uxd User experience (UX) designs notif/doc Notify the docs team that a doc update or addition is required

Comments

@sjcox-rh
Copy link
Contributor

sjcox-rh commented Jul 26, 2018

This is a...


[ X] Feature request
[ ] Regression (a behavior that used to work and stopped working in a new release)
[ ] Bug report  
[ ] Documentation issue or request

The problem

There are essentially two types of connectors:

Full Support connectors

  • have user stories
  • are tested
  • are documented
  • are fully supported by Red Hat

Preview connectors

  • do not require user stories
  • may or may not be tested
  • have upstream documentation at best
  • are not supported by Red Hat, but we do take feedback from customers and plan to include in product at some point

Need to visually differentiate the two groups. Preview connectors would be labeled "Preview"

Expected behavior

Preview connectors would be indicated as being a "Preview". Determine best visual indicator.

Screenshot

screen shot 2018-07-26 at 1 18 32 pm

Request and Response Data

API Endpoints and Schemas

Tasks involved / Steps to Reproduce

  1. Determine visual Design
  2. Review
  3. Implement
@sjcox-rh sjcox-rh added cat/design concrete UX design. Use this for PRs containing UX designs. cat/feature PR label for a new feature labels Jul 26, 2018
@sjcox-rh sjcox-rh self-assigned this Jul 26, 2018
@pure-bot pure-bot bot added the notif/triage The issue needs triage. Applied automatically to all new issues. label Jul 26, 2018
@dongniwang dongniwang added group/uxd User experience (UX) designs group/ui User interface SPA, talking to the REST backend notif/doc Notify the docs team that a doc update or addition is required labels Jul 26, 2018
@dongniwang
Copy link
Contributor

Wanted to find out if the indicator would show up only for connector cards or for both connector and connection cards?

cc: @heiko-braun @zregvart @avano @kcbabo

@sjcox-rh
Copy link
Contributor Author

sjcox-rh commented Jul 26, 2018

@dongniwang and I discussed the best approach for this as well as asked for suggestions from another visual designer.

We ultimately decided on the visual treatment below:

screen shot 2018-07-26 at 1 18 32 pm

The top image is an example of how the connector card would appear in the connection creation workflow.

The bottom card shows an example of a connection card (connection list view). Please note that not every connection card view will show a kabob menu or the config required notice. We just wanted to provide an example of what it would look like with all variations.

This approach is subtle enough to not distract the user from their flow, but informs the user that it's a preview connector.

The info icon would trigger a popover that would briefly explain what a preview connector is and how it's different from the rest. @TovaCohen Is this something you can help with?

@kcbabo @gashcrumb @paoloantinori @zregvart @heiko-braun @valdar @avano Please review and let us know if you have any feedback!

FYI: @amysueg @michael-coker @seanforyou23

@kcbabo
Copy link

kcbabo commented Jul 26, 2018

SHIP. IT.

@gashcrumb
Copy link
Contributor

+1

1 similar comment
@avano
Copy link
Member

avano commented Jul 27, 2018

+1

@heiko-braun
Copy link
Collaborator

@gashcrumb Can you pair with @zregvart for the implementation?

@heiko-braun heiko-braun added this to the Sprint 32 (4/5) milestone Jul 27, 2018
@heiko-braun heiko-braun removed the notif/triage The issue needs triage. Applied automatically to all new issues. label Jul 27, 2018
@zregvart zregvart self-assigned this Jul 27, 2018
@gashcrumb
Copy link
Contributor

Of course! @zregvart maybe we can just add a metatdata item to the connector if it supports metadata. If not maybe we should sort that :-)

zregvart added a commit to zregvart/syndesis that referenced this issue Jul 27, 2018
Adds a new tag `tech-preview` that can be added to connectors that are
provided for early access technology preview.

First such Connector is the IRC Connector.

Visually when Connection is displayed the top of the Connection card
will contain `Technology preview` text, which is also displayed during
connection creation.

Fixes syndesisio#3201
@TovaCohen
Copy link
Collaborator

Customer Content Services has boilerplate text for describing Technology Preview features. Based on that:

Replace "Technical Preview" with "Technology Preview". This is the standard Red Hat term.

For the popover, depending on whether you want to be more cautious or more encouraging:

Cautious Option 1:

Technology Preview features are not supported with Red Hat production service-level agreements and might not be functionally complete. Red Hat does not recommend them for production.

Encouraging Option 2:

Technology Preview features provide early access to features that are not supported.

Whichever option you choose, the first two words, "Technology Preview" should be a link to more information here:

https://access.redhat.com/support/offerings/techpreview

@dongniwang
Copy link
Contributor

Here's the PF popover pattern https://www.patternfly.org/pattern-library/widgets/#popover

If we can link to more information via "Technology Preview", then my vote is the encouraging option 2.

zregvart added a commit to zregvart/syndesis that referenced this issue Jul 27, 2018
Adds a new tag `tech-preview` that can be added to connectors that are
provided for early access technology preview.

First such Connector is the IRC Connector.

Visually when Connection is displayed the top of the Connection card
will contain `Technology preview` text, which is also displayed during
connection creation.

Fixes syndesisio#3201
@zregvart
Copy link
Member

@TovaCohen currently we have: Technology preview (lowercase p) and We're happy to provide you with this early access preview feature, we encourage to provide feedback but limit our support to best effort..
I can change to what you suggest. I was thinking of something that would encourage feedback. What do you think?

@dongniwang I opted to work with the tooltips we already have, it looks like this:
screenshot from 2018-07-27 18-57-24

Does that work?

@pure-bot pure-bot bot closed this as completed in #3206 Jul 27, 2018
@dongniwang
Copy link
Contributor

dongniwang commented Jul 27, 2018

@zregvart - The issue with using tooltip is that we can't have links in tooltips and tooltips only appear on hover. I agreed with Tova that having the link to that page is a good idea since it provides a comprehensive explanation.

In terms of wording, I would recommend following suggestions provided by @TovaCohen. Also, is there a reason why we're using lowercase p?

I can't tell what color we're using for the word and the icon, but please make sure they're using pf-black-600 #72767b (see https://www.patternfly.org/styles/color-palette/) since we want that line to be less intrusive to the users. Maybe @michael-coker could help with this?

@dongniwang dongniwang reopened this Jul 27, 2018
@TovaCohen
Copy link
Collaborator

I think that the link to the details is a requirement. The user needs to be able to easily learn that Technology Preview features do not have support, are not recommended for production, could change in the future, and might not be completely documented.

Please make sure that both Technology and Preview always have an initial cap.

How do you want users to provide the feedback? Open a support request? Click Help > Contact Us? Send an email to fuse-online-evaluation@redhat.com?

Assuming that the first two words in the text is a link to the URL in my previous comment, for the text in the UI popover, how about:

Technology Previews provide early access to features that are not yet supported. Feedback about these features is welcome. Send a message to fuse-online-evaluation@redhat.com.

@zregvart
Copy link
Member

@TovaCohen not sure about it being a link I think if you interact with the tooltip as it is now it will dismiss the tooltip, let me try.

@dongniwang
Copy link
Contributor

@zregvart - can we change tooltip to popover? I believe you can have links in popover. https://www.patternfly.org/pattern-library/widgets/#popover

cc: @michael-coker

@gashcrumb
Copy link
Contributor

@dongniwang that popover impl isn't applicable here, it uses jquery.

@zregvart we'd want to use the ngx-bootstrap implementation -> https://valor-software.com/ngx-bootstrap/#/popover

should be a matter of replacing [title] with popover in the template.

@dongniwang
Copy link
Contributor

I was checking the implementation on staging site and noticed we didn't link the first two words to https://access.redhat.com/support/offerings/techpreview.

Please link the two words to the above link.

cc: @michael-coker

screen shot 2018-07-31 at 10 54 32 am

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cat/design concrete UX design. Use this for PRs containing UX designs. cat/feature PR label for a new feature group/ui User interface SPA, talking to the REST backend group/uxd User experience (UX) designs notif/doc Notify the docs team that a doc update or addition is required
Projects
None yet
Development

Successfully merging a pull request may close this issue.

8 participants