search

syndesisio / syndesis-ux

UX Designs for Syndesis
Apache License 2.0
2 stars 9 forks source link

Create help icon in UI with link to iPaaS product documentation #31

Closed dongniwang closed 7 years ago

dongniwang commented 7 years ago

@fbolton commented on Mon Mar 13 2017

This is a suggestion that comes from Nacia Owens, as low-cost way of integrating the iPaaS docs (created by the Fuse documentation team) with the UI:

here's an idea that might be quick to implement: can you include a simple, clickable help icon (?) in the banner that would take the user to the iPaaS document on the portal? If Fintan provides the URL for the page where the iPaaS doc will be published, it might be possible to implement this link as a first step towards providing help in the UI?

@naciao commented on Tue Mar 21 2017

Revising the timeline for this item: the documentation target for the linked help icon will be delivered for the technology preview, not for the demo.

@naciao commented on Tue May 16 2017

Suggest that we promote this up and out of the backlog, perhaps re-evaluate what kind of embedded help would be most useful to the citizen integrator, and plan to provide some help in the UI for the technology preview.

@dongniwang commented on Wed Aug 09 2017

@gashcrumb @kahboom Any objections of me moving this to the ux repo? If possible, let's target this for sprint 16?

cc: @sjcox-rh

@gashcrumb commented on Wed Aug 09 2017

+1 go for it!

naciao commented 7 years ago

Thanks for moving this into sprint 16. Let me know when you need the doc URL, I will coordinate with Fintan on his Fuse doc Jira that tracks this (https://issues.jboss.org/browse/FUSEDOC-2121).

dongniwang commented 7 years ago

The help icon is added as part of the First Time User Experience design, see https://github.com/syndesisio/syndesis-ux/issues/30.

Implementation of the help icon can be found here http://www.patternfly.org/pattern-library/application-framework/masthead/

cc: @sjcox-rh @naciao @gashcrumb @kahboom

fbolton commented 7 years ago

For the TP1 sample tutorial(s), you can use either of the following URLs for the help icon (depending on whether you prefer single-page HTML or multi-page HTML):

Single-page HTML: https://access.redhat.com/documentation/en-us/red_hat_jboss_fuse/6.3/html-single/fuse_ignite_sample_integration_tutorial/

Multi-page HTML: https://access.redhat.com/documentation/en-us/red_hat_jboss_fuse/6.3/html/fuse_ignite_sample_integration_tutorial/

Currently, there is a dummy doc at this location (so that you can verify the URL). At TP1 release time, this will be replaced by the content that @TovaCohen and @nichmoore are developing.

dongniwang commented 7 years ago

Issue moved to syndesisio/syndesis-ui #936 via ZenHub