Project

General

Profile

Actions

action #163004

closed

coordination #154768: [saga][epic][ux] State-of-art user experience for openQA

coordination #157510: [epic] Up-to-date JavaScript stack

Replace shepherd.js tour with a simple bootstrap hint pointing to first steps size:M

Added by okurz 6 months ago. Updated 4 months ago.

Status:
Resolved
Priority:
Normal
Assignee:
Category:
Feature requests
Target version:
Start date:
2024-06-28
Due date:
% Done:

0%

Estimated time:

Description

Motivation

According to the maintainer there's problems with getting shepherd.js packaged for Debian. We also struggle to update node dependencies from 11.2.0 (13.0.1 is the latest version right now) and people misuse and misunderstand the feature tour so we should replace the solution with something simpler, probably just a simple bootstrap hint pointing to first steps

Acceptance criteria

  • AC1: openQA no longer depends on the problematic shepherd.js
  • AC2: Feature tour is no longer misunderstood by new users

Suggestions

  • Go back in time and implement the tour using bootstrap c.f. #101385
  • Drop the tour and rely on making the UX discoverable using ? buttons and links to documentation
  • Check what's covered by the tour that isn't documented so far
  • Extend o-i-o tests to generate some screenshots of openQA in action (that are always uptodate) to use in documentation
  • https://github.com/os-autoinst/openQA/pull/5733

Related issues 2 (0 open2 closed)

Related to openQA Project (public) - action #101385: [ux][ui][openqa] remove Bootstrap-tour or use another solutionResolvedosukup2021-10-22

Actions
Related to openQA Tests (public) - action #165437: test fails in test_results: no don't notify popupResolvedjbaier_cz2024-08-18

Actions
Actions #1

Updated by okurz 6 months ago

  • Target version changed from Ready to Tools - Next
Actions #2

Updated by okurz 6 months ago

  • Target version changed from Tools - Next to future
Actions #3

Updated by livdywan 5 months ago

  • Related to action #101385: [ux][ui][openqa] remove Bootstrap-tour or use another solution added
Actions #4

Updated by livdywan 5 months ago

  • Subject changed from Replace first-time tour with simple bootstrap hint pointing to first steps to Replace shepherd.js tour with a simple bootstrap hint pointing to first steps
  • Description updated (diff)

I'm not sure why Debian was mentioned here. If anyone knows why that's relevant feel free to add, but afair we won't run this on Debian in production.

Actions #5

Updated by livdywan 5 months ago

Also https://github.com/os-autoinst/openQA/pull/5733 we have dependabot updates we can't use, meaning this should be High priority at this point

Actions #6

Updated by okurz 5 months ago

Please revert your change to delete the reference to Debian. Just because we don't run it on openQA doesn't mean nobody else did. The package maintainer and admin of the official Debian openQA instance mentioned that problem to me.

Actions #7

Updated by okurz 5 months ago

  • Description updated (diff)
  • Target version changed from future to Ready

@livdywan I brought back the original motivation. I don't understand "sheperherd.js isn't packaged for openSUSE". That's what is effectively the case for any other node module as well and that is why we use upstream npm handling.

Actions #8

Updated by livdywan 5 months ago

  • Description updated (diff)
  • Target version changed from Ready to future

okurz wrote in #note-6:

Please revert your change to delete the reference to Debian. Just because we don't run it on openQA doesn't mean nobody else did. The package maintainer and admin of the official Debian openQA instance mentioned that problem to me.

Thanks for clarifying. That's why I was asking.

Actions #9

Updated by okurz 5 months ago

  • Target version changed from future to Ready
Actions #10

Updated by livdywan 5 months ago

okurz wrote in #note-7:

I don't understand "sheperherd.js isn't packaged for openSUSE".

shepherd.js is the problematic dependency here. Hope this is clearer now.

Actions #11

Updated by livdywan 4 months ago

  • Subject changed from Replace shepherd.js tour with a simple bootstrap hint pointing to first steps to Replace shepherd.js tour with a simple bootstrap hint pointing to first steps size:M
  • Description updated (diff)
  • Status changed from New to Workable
Actions #12

Updated by mkittler 4 months ago

  • Status changed from Workable to In Progress
  • Assignee set to mkittler
Actions #13

Updated by mkittler 4 months ago

  • Status changed from In Progress to Feedback
Actions #14

Updated by mkittler 4 months ago

  • Status changed from Feedback to Resolved

The PR is merged and it fulfills the ACs.

Actions #15

Updated by okurz 4 months ago

  • Related to action #165437: test fails in test_results: no don't notify popup added
Actions

Also available in: Atom PDF