Part of #1921152: META: Start providing tour tips for other core modules.

Problem/Motivation

Write tour integration for forum.module

Proposed resolution

Create tour yml files for required admin screens in forum.

Remaining tasks

Review forum_menu() and decide on screens that require tour integration
Write tour integration

User interface changes

New tours

API changes

None

Technical pointers when creating tour tips

See: https://www.drupal.org/docs/8/api/tour-api/overview for tech notes on making tour tips.

CommentFileSizeAuthor
#33 forum-tour-1926296.33.patch9.73 KBAntti J. Salminen
#29 forum-tour-1926296.29.patch9.66 KBAntti J. Salminen
#25 forum-tour-1926296.25.patch9.52 KBAntti J. Salminen
#19 forum-tour-1926296.19.fail_.patch9.53 KBlarowlan
#19 forum-tour-1926296.19.pass_.patch10.2 KBlarowlan
#17 forum-tour.16.patch9.44 KBlarowlan
#12 forum-tour-1926296.12.patch7.22 KBlarowlan
#4 forum-tour-1926296.4.interdiff.txt1.5 KBnick_schuch
#4 forum-tour-1926296.4.patch9.52 KBnick_schuch
#4 forum_css_fix.png89 KBnick_schuch
#2 forum-tour-1926296.2.patch8.02 KBlarowlan
#2 forum-tour-1926296.2.interdiff.txt1.74 KBlarowlan
#1 Screen Shot 2013-03-02 at 5.47.53 PM.png52.02 KBlarowlan
#1 forum-tour-1926296.1.patch8.06 KBlarowlan
#1 Screen Shot 2013-03-02 at 5.32.02 PM.png34.33 KBlarowlan

Comments

larowlan’s picture

larowlan
Location 🇦🇺🏝.au GMT+10
commented
Status: Active » Needs review
StatusFileSize
new Screen Shot 2013-03-02 at 5.32.02 PM.png34.33 KB
new forum-tour-1926296.1.patch8.06 KB
new Screen Shot 2013-03-02 at 5.47.53 PM.png52.02 KB

Patch for review.
Adds three yml files to cover the forum admin listing and the add/edit forum and add/edit container forms.
Also adds minor changes to tour.js to allow for the modal option (when no data-id or data-class is provided).
This is used for a nice introduction to the point of the form.
Some screenshots below.
Full tour screencast here: http://youtu.be/ItLxCQgB7-c

Screen Shot 2013-03-02 at 5.47.53 PM.png

Screen Shot 2013-03-02 at 5.32.02 PM.png

larowlan’s picture

larowlan
Location 🇦🇺🏝.au GMT+10
commented
StatusFileSize
new forum-tour-1926296.2.interdiff.txt1.74 KB
new forum-tour-1926296.2.patch8.02 KB

Renames ids/files to remove reference to language as per #1935120: Unusual language use in tour module

nick_schuch’s picture

nick_schuch commented
Status: Needs review » Needs work

Here is a screencast of the tour: http://youtu.be/BjoPEisDOrk

The content looks really good. Ill make sure to add a line about "Use examples" in the pattern definition documentation.

We should add some css in to provide a margin for the tips that touch the bottom of the page. What do you think?

nick_schuch’s picture

nick_schuch commented
StatusFileSize
new forum_css_fix.png89 KB
new forum-tour-1926296.4.patch9.52 KB
new forum-tour-1926296.4.interdiff.txt1.5 KB

This following adds to the patch and adds some gap between the bottom of the browser and the tip.
forum_css_fix.png

nick_schuch’s picture

nick_schuch commented
Status: Needs work » Needs review

Status: Needs review » Needs work

The last submitted patch, forum-tour-1926296.4.patch, failed testing.

nick_schuch’s picture

nick_schuch commented
Status: Needs work » Needs review

#4: forum-tour-1926296.4.patch queued for re-testing.

tstoeckler’s picture

tstoeckler
he/him
Primary language German
Location Essen, Germany
commented

As the Joyride library is external code I don't think we should be modifying it. I think it would be better to override the selectors in tour.css or whatever.

nick_schuch’s picture

nick_schuch commented

Thanks for the review tstoeckler. After a discussion with larowlan today we need to revert back the css anyway. I completely understand what you mean.

I think if we cannot solve the issue (if it arises again) we can talk about it then. Did you happen to review the tour content?

tstoeckler’s picture

tstoeckler
he/him
Primary language German
Location Essen, Germany
commented

Not yet, I hope to very soon, though.

nick_schuch’s picture

nick_schuch commented

Thanks tstoeckler!

larowlan’s picture

larowlan
Location 🇦🇺🏝.au GMT+10
commented
StatusFileSize
new forum-tour-1926296.12.patch7.22 KB

Reroll

larowlan’s picture

larowlan
Location 🇦🇺🏝.au GMT+10
commented

http://s00940b77ab6f5d5.s3.simplytest.me/ admin/power if you want a run through
expires in 15

larowlan’s picture

larowlan
Location 🇦🇺🏝.au GMT+10
commented

Needs #1995152-7: Broken selector for the overview item to work

larowlan’s picture

larowlan
Location 🇦🇺🏝.au GMT+10
commented
Issue summary: View changes

Updated summary

larowlan’s picture

larowlan
Location 🇦🇺🏝.au GMT+10
commented
Status: Needs review » Postponed

This is needs work as it should add tests to ensure the markup is present.
Blocked on #2028535: Provide a TourTestBase class for use by core and contrib modules

larowlan’s picture

larowlan
Location 🇦🇺🏝.au GMT+10
commented
Status: Postponed » Active

Back on this

larowlan’s picture

larowlan
Location 🇦🇺🏝.au GMT+10
commented
Status: Active » Needs review
StatusFileSize
new forum-tour.16.patch9.44 KB

This fails because we've lost the action buttons.
Need to add a new issue (bug) for that.

Status: Needs review » Needs work

The last submitted patch, forum-tour.16.patch, failed testing.

larowlan’s picture

larowlan
Location 🇦🇺🏝.au GMT+10
commented
Assigned: larowlan » Unassigned
Status: Needs work » Needs review
StatusFileSize
new forum-tour-1926296.19.pass_.patch10.2 KB
new forum-tour-1926296.19.fail_.patch9.53 KB

Fail/pass demonstrating we have a) tour test coverage and b) fix for #2073197: Local actions 'add new forum|container' no longer found at admin/stucture/forums

Status: Needs review » Needs work

The last submitted patch, forum-tour-1926296.19.pass_.patch, failed testing.

larowlan’s picture

larowlan
Location 🇦🇺🏝.au GMT+10
commented

Test bot runs in a sub directory, need to rethink selectors

larowlan’s picture

larowlan
Location 🇦🇺🏝.au GMT+10
commented
Status: Needs work » Postponed

Postponing until #2073197: Local actions 'add new forum|container' no longer found at admin/stucture/forums is fixed

larowlan’s picture

larowlan
Location 🇦🇺🏝.au GMT+10
commented
Issue summary: View changes

Updated issue summary.

larowlan’s picture

larowlan
Location 🇦🇺🏝.au GMT+10
commented
Issue summary: View changes
Status: Postponed » Active
Antti J. Salminen’s picture

Antti J. Salminen commented
Assigned: Unassigned » Antti J. Salminen

Working a bit on this.

Antti J. Salminen’s picture

Antti J. Salminen commented
Assigned: Antti J. Salminen » Unassigned
StatusFileSize
new forum-tour-1926296.25.patch9.52 KB

Rerolled with routes, PSR-4, config move and removed the fix that went in with another commit as far as I can see.

Antti J. Salminen’s picture

Antti J. Salminen commented
Status: Active » Needs review

Triggering tests to see where the patch stands.

Status: Needs review » Needs work

The last submitted patch, 25: forum-tour-1926296.25.patch, failed testing.

Antti J. Salminen’s picture

Antti J. Salminen commented
Assigned: Unassigned » Antti J. Salminen
Antti J. Salminen’s picture

Antti J. Salminen commented
Assigned: Antti J. Salminen » Unassigned
StatusFileSize
new forum-tour-1926296.29.patch9.66 KB

Some reroll changes.

nick_schuch’s picture

nick_schuch commented
Status: Needs work » Needs review

Status: Needs review » Needs work

The last submitted patch, 29: forum-tour-1926296.29.patch, failed testing.

Antti J. Salminen’s picture

Antti J. Salminen commented
Assigned: Unassigned » Antti J. Salminen

Working on getting the tests to pass again.

Antti J. Salminen’s picture

Antti J. Salminen commented
Assigned: Antti J. Salminen » Unassigned
Status: Needs work » Needs review
StatusFileSize
new forum-tour-1926296.33.patch9.73 KB

This should pass more tests than previously. The forum edit page delete link is not present on the page with the "administer forums" permission. Looks like there is a bug with the forum permissions instead of an issue with the tour itself.

Status: Needs review » Needs work

The last submitted patch, 33: forum-tour-1926296.33.patch, failed testing.

webchick’s picture

webchick
she/they
Primary language English
Location Vancouver 🇨🇦
commented
Status: Needs work » Postponed

This one seems like a good thing to do, but postponed on #1921152-109: META: Start providing tour tips for other core modules. for now.

mgifford’s picture

mgifford
he/him
Primary language English
commented
Related issues: +#1921152: META: Start providing tour tips for other core modules.

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.

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.

dorficus’s picture

dorficus commented
Issue summary: View changes

Noticed that the link points to an anchor that isn't there. On #1921152-69: META: Start providing tour tips for other core modules. the anchor this link pointed to has gone to its own doc page.

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 commented

Forum is approved for removal. See #1898812: [policy] Deprecate forum module for removal in Drupal 11

This is now Postponed. The status is set according to two policies. The Remove a core extension and move it to a contributed project and the Extensions approved for removal policies.

It will be moved to the contributed extension once the Drupal 11 branch is open.

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

Drupal core is moving towards using a “main” branch. As an interim step, a new 11.x branch has been opened, as Drupal.org infrastructure cannot currently fully support a branch named main. New developments and disruptive changes should now be targeted for the 11.x 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 commented
Project: Drupal core » Forum
Version: 11.x-dev » 1.0.1
Component: forum.module » Code
larowlan’s picture

larowlan
Location 🇦🇺🏝.au GMT+10
commented
Status: Postponed » Closed (won't fix)

Tour is gone from core and I think improving the UX so tours aren't needed is probably better use of time