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

Create a tour for query builder #548

Open
heralden opened this issue Jul 9, 2020 · 3 comments
Open

Create a tour for query builder #548

heralden opened this issue Jul 9, 2020 · 3 comments
Labels
Query Builder usertesting Opinionated findings from usertests

Comments

@heralden
Copy link
Member

heralden commented Jul 9, 2020

The query builder is pretty much the only page that's impossible to figure out unless someone walks you through it.

Here would be a useful place to have a tour/tutorial. If we end up creating a video tutorial for it, this can be achieved by simply having a big HELP, TUTORIAL or What is this? button which opens a modal with the video embedded.

@heralden heralden added Query Builder usertesting Opinionated findings from usertests labels Jul 9, 2020
@sammyjava
Copy link
Member

We're thinking hard about tours for our hard-to-grok webapp Genomic Context Viewer, which is client-side, so we'll keep an eye on what you do for the Query Builder. @adf-ncgr

@adf-ncgr
Copy link

adf-ncgr commented Jul 9, 2020

just a quick note from my side.

we've done tours so far (including for GCV) using http://bootstraptour.com/ but it seems to be not actively developed for a couple of years; a fork has been created that seems to be carrying on, at least with respect to some things that have gotten broken by changes to new versions of bootstrap itself; see the wonderfully named https://github.com/IGreatlyDislikeJavascript/bootstrap-tourist
this issue: sorich87/bootstrap-tour#729
explains why if you try to "Take the Tour" at https://legumeinfo.org/lis_context_viewer/instructions you will
get tour steps with no apparent means to advance them (but you can use keystroke -> and <- to navigate).
That seems to be the primary reason that IGreatlyDislikeJavascript created the fork.

I was not actually aware of the new fork when we started looking into switching over to https://introjs.com/
one of our main requirements is support for "multi-page tours" which these both do, although there is a greater difference in how they approach this than I was expecting.

Anyway, we are indeed interested in how tours can enable users to master the complexities of using powerful tools to pursue their own research questions, so we'll definitely be happy to discuss further when appropriate

@heralden
Copy link
Member Author

Thank you for sharing these libs!

The query builder is probably simpler than the GCV, and it also only spans one page. We will probably start off with an embedded video tutorial, (if we manage to get a GSoD intern) but if we decide to create a tour IntroJS looks like a good candidate.

I think there is also more potential for tours in Bluegenes, like

  • overview of how to use Bluegenes/Intermine
  • im-tables
  • other pages as they become more advanced, like the Lists and Report pages

so I think this medium can be explored further in the future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Query Builder usertesting Opinionated findings from usertests
Projects
None yet
Development

No branches or pull requests

3 participants