Add more information to the tour project page

Created on 30 August 2024, 3 months ago
Updated 16 September 2024, 2 months ago

Problem/Motivation

At the moment the project page for the tour module is quite minimalistic. The description is probably a shortened version of https://www.drupal.org/docs/extending-drupal/contributed-modules/contrib... with the first sentence "The Tour module is included in Drupal core" removed. Module categories are not assigned at this point. The omitted categories make it more difficult to surface the module in the context of the upcoming project browser or on the module search page on d.o right now ( https://www.drupal.org/docs/extending-drupal/contributed-modules/contrib... ) . Same for the brief project description, that is the content search queries base their results on. Plus the tour module now already has added additional functionality compared back to then time when it was still in core.

Steps to reproduce

Proposed resolution

In regards of the project description how about adding a screenshot to illustrate how a guided tour is actually looking like and then add a list of functionality like the merged tour ui module, the ability to have a tour button in case the user has no access to the toolbar, etc, as well as the functionality that already existed back when it was in core. Also note that it is based on shepherd.
For the categories i wonder if it would be enough to add it to the Accessibility category? I am not sure if any of the other categories would apply as well (see the scope notes at https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or... ).

Remaining tasks

User interface changes

API changes

Data model changes

📌 Task
Status

Fixed

Version

2.0

Component

Miscellaneous

Created by

🇩🇪Germany rkoller Nürnberg, Germany

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

    Primarily changes documentation, not code. For Drupal core issues, select the Documentation component instead of using this tag. In general, component selection is preferred over tag selection.

Sign in to follow issues

Comments & Activities

  • Issue created by @rkoller
  • Status changed to Needs review 3 months ago
  • 🇺🇸United States smustgrave

    Updated

  • Status changed to Needs work 3 months ago
  • 🇩🇪Germany rkoller Nürnberg, Germany

    The general direction looks fab thank you! only a few nitpicks:

    Each tour consists of several tips that highlight elements of the user interface, guide the user through a workflow, or explain key concepts of the website.

    one question, does guiding through a workflow mean i am able to create tours that span across several pages? meaning for example a tour for adding a field? based on the answer i might come up with a suggestion for this sentence then.

    Settings form to control text

    the following improvement listed is not clear what it actually refers to. instead i would suggest something like:
    Settings form to control the label of the button for starting a tour

    And i would remove tours from the Accessibility ecosystem. the accessibility project is about testing accessibility not being the umbrella for a11y modules in general. i would still add the tour module to the accessibility category instead. cuz if you search for the term tour within the accessibility category you only find the editoria11y checker as the sole result: https://www.drupal.org/project/project_module?f%5B0%5D=&f%5B1%5D=&f%5B2%...

  • Status changed to Needs review 3 months ago
  • 🇺🇸United States smustgrave

    So I actually copied this from the help topics. Yes technically a workflow can be multiple pages and you can write tours for each page.

    Made other changes

  • 🇩🇪Germany rkoller Nürnberg, Germany

    ahhh ok, but those tours on the pages a workflow spans across can't be interlinked and listed programmatically for a tour? i've rechecked the shepherd usage guide https://docs.shepherdpro.com/guides/usage/ in that regard, there is no direct indication for that feature, nor the ui of the tour module is reflecting that ability. so i wonder if the following slight simplification would make sense.

    Change Each tour consists of several tips that highlight elements of the user interface, guide the user through a workflow, or explain key concepts of the website. to Each tour consists of several tips that highlight elements of the user interface, explaining key concepts and functionality on a page.
    *I just left out the part about workflows and instead added the point that the tips are not solely about concepts but also about functionality available on a page.

    Aside that I've noticed three more details about the points listed in the improvements section:

    Change Integrated Tour UI to have a visual interface for creating custom tours to Integrated the Tour UI module to provide a visual interface for creating new and editing existing tours
    *"Tour UI" might not be necessarily clear that it refers to the Tours UI module. And aside creating tours there is also the option to edit existing tours which was not possible before either.

    Change Almost 4x as many default Tours to Almost four times as many tours available
    *in regards of readability 4x is hard to skim and process. numbers smaller ten should always be written out plus the x makes the reader also think for a second what it means in that context - instead just write things out. and why not just use "available" instead of "default" and i guess tours should be lower case since it is not a title?

    Change Tour block to allow tours to run without the toolbar to The button block for starting a tour to allow to run tours without the toolbar...
    *not necessary clear what a tour block entails. Simply adding the detail that the block contains a button to start a tour.

  • 🇺🇸United States smustgrave

    Not a feature I plan to add. We have tours for different steps of field ui

    I’ll make a few more changes but probably close this out as there other things to work on

  • Status changed to Fixed 3 months ago
  • Automatically closed - issue fixed for 2 weeks with no activity.

Production build 0.71.5 2024