[meta] Add tours to improve the onboarding

Created on 3 January 2023, almost 2 years ago
Updated 22 February 2024, 10 months ago

Problem/Motivation

At the moment the onboarding for screen reader users, aside the general a11y related issues upstream, to communicate the basic concepts of ECA and BPMN, is sort of challenging - it is simply difficult near to impossible to orient and grasp the general basic structure without any visual queues. An aspect that is even potentially an issue for some sighted users.

Steps to reproduce

Proposed resolution

It might be beneficial to add tours for the Tour module in Core. I've already created four working tours with a differing number of tips in a local install. i would suggest these four tours. I've only added the basic outline of tips for each tour without any descriptions added yet. wanted to get a consensus first if the addition of the feature would make sense and if the outline makes sense:

ECA main tour (route: entity.eca.collection):

  1. a general tip with no focus
  2. models tab in focus
  3. import tab in focus
  4. settings tab in focus
  5. log tab in focus
  6. parameters tab in focus (the tip is defined but is only displayed when the parameters module is installed)
  7. add new model button in focus - quickly explain that either a new model editing screen is opened if a single modeler is installed or you have the option to choose in which modeler you want to create your model in if more than one modeler is installed.

=> ideally it would be good to add a tip to several or even each of the columns available but i am not sure with which selector that could be accomplished. so far i lean towards having a single tip for #edit-eca-entities thead
=> I wouldn't create a dedicated tour for the import and log pages.

ECA Settings tour (route:eca.settings):

  1. log level select list in focus
  2. documentation domain field in focus
  3. execute models with user field in focus
  4. dependency field set in focus
  5. entity checkbox configs label in focus
  6. field storage configurations label in focus
  7. field configurations per bundle label in focus
  8. newly added field configurations per bundle in label in focus

=> not sure yet if tip 5-8 is necessary and tip 4 might be already enough

ECA parameters tour (route: entity.eca.parameters):

  1. parameters field set in focus
  2. add new parameter field set in focus
  3. type select list in focus

ECA model tour (route: entity.eca.edit_form):

  1. whole toolbar in focus
  2. hand tool icon in focus
  3. lasso tool icon in focus
  4. space tool icon in focus
  5. connection multi icon in focus
  6. start event icon in focus
  7. gateway icon in focus
  8. task icon in focus
  9. whole property panel in focus
  10. property panel general section in focus
  11. property panel documentation section in focus
  12. property panel extension property section in focus

=> there are two problems first i dont know if and how to expand a section in the properties panel. if i target a selector of a field inside a collapsed section the tip isn't expanding the section nor it is shown. the other problem it is probably also impossible to provide tips for elements of a model? if one is creating a new model and hits the tour button right after only the toolbar and properties panel would be covered the canvas would be empty without any components on it yet. would it make sense to ship eca with one demo model out of the box? then it might be possible to target specific elements for that model - because the model name as well as the elements of that model are known and the tour wouldn't be shown for each and every model?
=> adding a tip for the element template chooser is also tricky to accomplish first the button to open the template chooser is hidden in a collapsed section and second to reach the chooser it is also necessary to click the aforementioned inaccessible button.

Remaining tasks

User interface changes

API changes

Data model changes

Feature request
Status

Active

Version

2.0

Component

User interface

Created by

🇩🇪Germany rkoller Nürnberg, Germany

Live updates comments and jobs are added and updated live.
  • Usability

    Makes Drupal easier to use. Preferred over UX, D7UX, etc.

  • Accessibility

    It affects the ability of people with disabilities or special needs (such as blindness or color-blindness) to use Drupal.

Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Production build 0.71.5 2024