Overview

This META task is to be used to provide an overview of the progress on Tour.module.

Tasks of mention

#1921152: META: Start providing tour tips for other core modules.
#1942576: Tour tips to be able to link to other pages and start tour's automatically.
#1921188: Implement Tour UI module
#1921136: Previous button for tour tips
#1938032: Simplify tour.js
#1924202: Tour tips are provided as configuration, so never get updated
#1921144: Role based system for tips
#2027447: Tourtip plugin exception should report both plugin and tip ids
#1920462: Show (disabled) Tour and Edit buttons on pages with no tour/edit available
#2027623: De-fork jQuery Joyride and update to latest stable release
#2031607: hook_tour_tips_alter is kinda blocking the Tour writer process
#2019469: Tour module should use token for it's body
#2030067: Human readable titles for Tour Tip plugin types
#2028535: Provide a TourTestBase class for use by core and contrib modules
#2072575: Tour API claims there's a cache_tour but using it causes exception.
#2073891: Customise tour loading by URL
#2074835: Tour: make operations enable | disable available for tours
#2084483: Weird test results while testing Tour UI on TipPluginImage
#2069073: Allow Tours to be taken by users that cannot access the Toolbar (e.g. anonymous users)
#2035145: Create hook_help for Tour module

Issue about the Tour module
Issue tags with Tour

API

Tour API - [#1934442]

Comments

nick_schuch’s picture

nick_schuch CreditAttribution: nick_schuch commented

The following outcomes were from the first discussion with Bojhan.

- Bojhan recommends that we define a pattern for tour tips creation eg. http://drupal.org/node/1087100
- We should compile a list and target major core items first (Views, Field UI etc).
- Bojhan is going to bring up Tour in the next UX meeting.
- Tour UI to be in contrib. (http://drupal.org/node/1921188)
- Multi Page will be tackled if required but will required a lot more work. (Possibly in a Field UI tour).
- Regular meetings are going to be setup to track progress (roughly once every 2 or 3 weeks).

nick_schuch’s picture

nick_schuch CreditAttribution: nick_schuch commented

As per recommendations this is my proposed pattern:

Problem

A subset of page elements require contextual information to provide the end user with additional information or instructions.

Solution

Develop a set of tips that are toggled via the "Tour" button located in the toolbar's top right.

Use when

* A subset of page elements that interact together and the "description" field does not provide sufficient detail.

Recommendations

* Keep the tip short, perferably 1 to 2 sentences.
* Don't provide too many tips. Less is more.
* Make tour tips tell a story that flows from one tip to the next.
* Write examples to provide a deeper understanding of element.

API

Tour API - http://drupal.org/node/1934442

nick_schuch’s picture

nick_schuch CreditAttribution: nick_schuch commented
Issue summary: View changes

Updated issue summary.

clemens.tolboom’s picture

clemens.tolboom
Primary language Dutch
Location Groningen, 🇳🇱/🇪🇺
CreditAttribution: clemens.tolboom commented

To make the picture more complete
#2027447: Tourtip plugin exception should report both plugin and tip ids
#1920462: Show (disabled) Tour and Edit buttons on pages with no tour/edit available
#2027623: De-fork jQuery Joyride and update to latest stable release
#2031607: hook_tour_tips_alter is kinda blocking the Tour writer process
#2019469: Tour module should use token for it's body

clemens.tolboom’s picture

clemens.tolboom
Primary language Dutch
Location Groningen, 🇳🇱/🇪🇺
CreditAttribution: clemens.tolboom commented
Issue summary: View changes

Added links to other Tour related issues + API

clemens.tolboom’s picture

clemens.tolboom
Primary language Dutch
Location Groningen, 🇳🇱/🇪🇺
CreditAttribution: clemens.tolboom commented
Issue summary: View changes

Updated issue summary.

clemens.tolboom’s picture

clemens.tolboom
Primary language Dutch
Location Groningen, 🇳🇱/🇪🇺
CreditAttribution: clemens.tolboom commented
Issue summary: View changes

Updated issue summary.

clemens.tolboom’s picture

clemens.tolboom
Primary language Dutch
Location Groningen, 🇳🇱/🇪🇺
CreditAttribution: clemens.tolboom commented
Issue summary: View changes

Updated issue summary.

clemens.tolboom’s picture

clemens.tolboom
Primary language Dutch
Location Groningen, 🇳🇱/🇪🇺
CreditAttribution: clemens.tolboom commented
Issue summary: View changes

Updated issue summary.

clemens.tolboom’s picture

clemens.tolboom
Primary language Dutch
Location Groningen, 🇳🇱/🇪🇺
CreditAttribution: clemens.tolboom commented

#2030067: Human readable titles for Tour Tip plugin types
#2028535: Provide a TourTestBase class for use by core and contrib modules
#2072575: Tour API claims there's a cache_tour but using it causes exception.
#2073891: Customise tour loading by URL
#2074835: Tour: make operations enable | disable available for tours
#2084483: Weird test results while testing Tour UI on TipPluginImage
#2069073: Allow Tours to be taken by users that cannot access the Toolbar (e.g. anonymous users)

clemens.tolboom’s picture

clemens.tolboom
Primary language Dutch
Location Groningen, 🇳🇱/🇪🇺
CreditAttribution: clemens.tolboom commented
Issue summary: View changes

Updated issue summary.

clemens.tolboom’s picture

clemens.tolboom
Primary language Dutch
Location Groningen, 🇳🇱/🇪🇺
CreditAttribution: clemens.tolboom commented

Issues marked for documentation fail to be listed either by tour.module or tour tag.

I worked on #1920470: Find out how help and tour can work together to find out #2035145: Create hook_help for Tour module exists.

clemens.tolboom’s picture

clemens.tolboom
Primary language Dutch
Location Groningen, 🇳🇱/🇪🇺
CreditAttribution: clemens.tolboom commented
Issue summary: View changes

Updated issue summary.

clemens.tolboom’s picture

clemens.tolboom
Primary language Dutch
Location Groningen, 🇳🇱/🇪🇺
CreditAttribution: clemens.tolboom commented
Issue summary: View changes

Added hook_help issue

Version: 8.0.x-dev » 8.1.x-dev

Drupal 8.0.6 was released on April 6 and is the final bugfix release for the Drupal 8.0.x series. Drupal 8.0.x will not receive any further development aside from security fixes. Drupal 8.1.0-rc1 is now available and sites should prepare to update to 8.1.0.

Bug reports should be targeted against the 8.1.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.2.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.1.x-dev » 8.2.x-dev

Drupal 8.1.9 was released on September 7 and is the final bugfix release for the Drupal 8.1.x series. Drupal 8.1.x will not receive any further development aside from security fixes. Drupal 8.2.0-rc1 is now available and sites should prepare to upgrade to 8.2.0.

Bug reports should be targeted against the 8.2.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.3.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.2.x-dev » 8.3.x-dev

Drupal 8.2.6 was released on February 1, 2017 and is the final full bugfix release for the Drupal 8.2.x series. Drupal 8.2.x will not receive any further development aside from critical and security fixes. Sites should prepare to update to 8.3.0 on April 5, 2017. (Drupal 8.3.0-alpha1 is available for testing.)

Bug reports should be targeted against the 8.3.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.4.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.3.x-dev » 8.4.x-dev

Drupal 8.3.6 was released on August 2, 2017 and is the final full bugfix release for the Drupal 8.3.x series. Drupal 8.3.x will not receive any further development aside from critical and security fixes. Sites should prepare to update to 8.4.0 on October 4, 2017. (Drupal 8.4.0-alpha1 is available for testing.)

Bug reports should be targeted against the 8.4.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.5.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.4.x-dev » 8.5.x-dev

Drupal 8.4.4 was released on January 3, 2018 and is the final full bugfix release for the Drupal 8.4.x series. Drupal 8.4.x will not receive any further development aside from critical and security fixes. Sites should prepare to update to 8.5.0 on March 7, 2018. (Drupal 8.5.0-alpha1 is available for testing.)

Bug reports should be targeted against the 8.5.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.6.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Mile23’s picture

Mile23
Primary language English
Location Seattle, WA
CreditAttribution: Mile23 as a volunteer commented
Issue summary: View changes

Is it true that there are no functional javascript tests of the tour module? Maybe there are nightwatch tests I can't find?

Asking because I'm working on this: #2940089: Clean up tour_example tests

It'd be nice to have some way to prove that tours work in JS so that implementations can just test that the lists exist in page markup.

Version: 8.5.x-dev » 8.6.x-dev

Drupal 8.5.6 was released on August 1, 2018 and is the final bugfix release for the Drupal 8.5.x series. Drupal 8.5.x will not receive any further development aside from security fixes. Sites should prepare to update to 8.6.0 on September 5, 2018. (Drupal 8.6.0-rc1 is available for testing.)

Bug reports should be targeted against the 8.6.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.7.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.6.x-dev » 8.8.x-dev

Drupal 8.6.x will not receive any further development aside from security fixes. Bug reports should be targeted against the 8.8.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.9.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 8.8.x-dev » 8.9.x-dev

Drupal 8.8.7 was released on June 3, 2020 and is the final full bugfix release for the Drupal 8.8.x series. Drupal 8.8.x will not receive any further development aside from security fixes. Sites should prepare to update to Drupal 8.9.0 or Drupal 9.0.0 for ongoing support.

Bug reports should be targeted against the 8.9.x-dev branch from now on, and new development or disruptive changes should be targeted against the 9.1.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 8.9.x-dev » 9.2.x-dev

Drupal 8 is end-of-life as of November 17, 2021. There will not be further changes made to Drupal 8. Bugfixes are now made to the 9.3.x and higher branches only. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.2.x-dev » 9.3.x-dev

Version: 9.3.x-dev » 9.4.x-dev

Drupal 9.3.15 was released on June 1st, 2022 and is the final full bugfix release for the Drupal 9.3.x series. Drupal 9.3.x will not receive any further development aside from security fixes. Drupal 9 bug reports should be targeted for the 9.4.x-dev branch from now on, and new development or disruptive changes should be targeted for the 9.5.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.4.x-dev » 9.5.x-dev

Drupal 9.4.9 was released on December 7, 2022 and is the final full bugfix release for the Drupal 9.4.x series. Drupal 9.4.x will not receive any further development aside from security fixes. Drupal 9 bug reports should be targeted for the 9.5.x-dev branch from now on, and new development or disruptive changes should be targeted for the 10.1.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

quietone’s picture

quietone CreditAttribution: quietone at PreviousNext commented
Status: Active » Closed (outdated)

This issue has not been used to track progress of the module in 10 years. If someone is to pick up the work again I would expect them to do their own evaluation of the remaining issues and create a new list, if they think it is needed.

Because this hasn't been used in so long and that module has been approved for removal from core and moved to contrib, I am closing this issue.