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

Problem/Motivation

Write tour integration for shortcuts page

Proposed resolution

Create tour yml files for shortcuts page

Remaining tasks

Provide patch of tour integration for the shortcuts page

User interface changes

New tours

API changes

None

Technical pointers when creating tour tips

See: https://drupal.org/node/1921152#tour-tips-tech-note for tech notes on making tour tips.

CommentFileSizeAuthor
#61 interdiff-2044407-59-61.txt1.31 KBmanuel.adan
#61 2044407-61.patch3.92 KBmanuel.adan
#59 diff-2044407-55-59.txt1.4 KBmanuel.adan
#59 2044407-59.patch3.92 KBmanuel.adan
#55 interdiff_53-55.txt563 bytesridhimaabrol24
#55 2044407-55.patch3.98 KBridhimaabrol24
#53 interdiff_52-53.txt1.1 KBridhimaabrol24
#53 2044407-53.patch3.97 KBridhimaabrol24
#52 interdiff_50-52.txt740 bytesridhimaabrol24
#52 2044407-52.patch4.07 KBridhimaabrol24
#50 interdiff_43-50.txt3.5 KBridhimaabrol24
#50 2044407-50.patch4.05 KBridhimaabrol24
#43 tour.shortcut-2044407-43.patch1.52 KBmkindred
#38 tour.shortcut-2044407-38.patch1.31 KBmkindred
#34 tour.shortcut-2044407-34.patch1.34 KBmkindred
#21 tour.shortcut-19.patch1.53 KBEc1ipsis
#19 tour.shortcut-19.patch1.53 KBEc1ipsis
#17 shortcut_tour_patch.png17.34 KBaczietlow
#10 tour.shortcut-10.patch1.73 KBEc1ipsis
#5 tour.shortcut-5.patch1.36 KBnielsonm
#4 tour.shotcut.patch876 bytesjgardezi
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

nick_schuch’s picture

Issue tags: +Needs tests

Tour needs tests since we now have #2028535

nick_schuch’s picture

Issue tags: +Tour

Tagging for tracking.

jgardezi’s picture

Assigned: Unassigned » jgardezi
Issue summary: View changes
jgardezi’s picture

Status: Active » Needs review
FileSize
876 bytes

Added shortcut patch

nielsonm’s picture

FileSize
1.36 KB

Changed the text a little, got the tour items working. Still needs tests though.

benjy’s picture

Status: Needs review » Needs work

This needs to be re-rolled to use routes now #1918768: Refactor tour module to use routes instead of paths is in.

Wim Leers’s picture

Assigned: jgardezi » Unassigned
Issue tags: +Novice
mr.baileys’s picture

Assigned: Unassigned » mr.baileys

Tackling this during the Belgian DUG sprint.

Ec1ipsis’s picture

Assigned: mr.baileys » Ec1ipsis

Assigning to myself as issue has been inactive for two weeks.

Ec1ipsis’s picture

FileSize
1.73 KB

New patch that updates shortcut Tour to use route instead of paths and adds additional tips to the shortcut Tour.

Ec1ipsis’s picture

Assigned: Ec1ipsis » Unassigned
Status: Needs work » Needs review

Status: Needs review » Needs work

The last submitted patch, 10: tour.shortcut-10.patch, failed testing.

Ec1ipsis’s picture

Status: Needs work » Needs review

10: tour.shortcut-10.patch queued for re-testing.

aczietlow’s picture

I applied the patch and had to reinstall the tour module (as you do).

Manually tested and looks good. The tour worked on the shortcut page.

r_morgan’s picture

I got the patch to apply.

The tour ran fine, after reinstalling the tour module just like aczietlow said above.

I have one concern though, to a new Drupal user the last tour item that points to removing a link would probably seem to point to a space that does nothing. To people who have been around a while it make sense to click the drop down arrow first but it might confuse new people.

Ec1ipsis’s picture

I think that most internet users are fairly familiar with drop downs/expansion by now. Given the pervasiveness of select lists and expanding menus in mobile responsiveness, I think it should be fairly intuitive. Anyone else have thoughts on this?

aczietlow’s picture

FileSize
17.34 KB

Attaching an screenshot that better captures the point made in #15

The issue is with step #5 in the tour. I think it would make sense to not have it overlap the drop down menu.

Ec1ipsis’s picture

Ahh! I see. Agreed, I'll see about adjusting that and get a new patch in for testing.

Ec1ipsis’s picture

FileSize
1.53 KB

Essentially, the target in question is too small to be accurately targeted by the arrow. Joyride aligns itself in relationship to the element, and then positions the nub about 25 pixels off of the corner in question. In practice, if you use "bottom" for the location (this is the default), Joyride will place the tip below the item, with the left edge of the tip aligned to the left edge of the element. The nub will then be approximately 25px from the top left corner, but the element in question is only about half that size, so the arrow appears to point to empty space. This is the behavior observed by rmorgan and aczietlow, but there isn't a position argument that adequately causes the arrow to point to the element. Drupal doesn't support the nubPosition argument that Joyride does, but even adding this argument wouldn't be sufficient to solve the problem of very small elements due to the limitations in the Joyride library.

With this in mind, I added some extra text to tip four indicating that the dropdown arrow was also responsible for deletions, and removed tip five. This patch is attached. Thoughts?

EDIT: For greater clarity and great justice!! (Or maybe just the clarity.)

Status: Needs review » Needs work

The last submitted patch, 19: tour.shortcut-19.patch, failed testing.

Ec1ipsis’s picture

FileSize
1.53 KB

Uploaded working patch.

aczietlow’s picture

Status: Needs work » Needs review

Marking for testing

aczietlow’s picture

21: tour.shortcut-19.patch queued for re-testing.

aczietlow’s picture

For testing the patch, I applied the patch, uninstalled and reinstalled the shortcuts module, and rebuilt the cache. I then navigate to the shortcuts management page (admin/config/user-interface/shortcut/manage/default/customize)

I'm only seeing 2 of the 4 steps listed in the patch.

Wim Leers’s picture

Status: Needs review » Needs work
Issue tags: +php-novice

I can see all four tour tips. But I think the wording/copywritings needs some love — it feels very rough. It doesn't have to be perfect though.

This also needs test coverage, see #1 and ViewsUITourTest.

webchick’s picture

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

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.

mkindred’s picture

Version: 8.5.x-dev » 8.6.x-dev
Assigned: Unassigned » mkindred
Status: Postponed » Active
Issue tags: +Nashville2018

Working on this issue from mentored core sprint @ Nashville DrupalCon.

mkindred’s picture

Patch for the first shortcuts management page. I'd think that subsequent pages are mostly common UI, so probably won't need tour elements.

mkindred’s picture

Status: Active » Needs review
Farnoosh’s picture

uuid needs to be removed. please add another patch. Thanks

Farnoosh’s picture

Status: Needs review » Needs work
mkindred’s picture

Ha ha, you're correct. This should be better.

Farnoosh’s picture

Remove hyphenated word in the shortcut general, I guess. Thanks

mkindred’s picture

Status: Needs work » Needs review

The last submitted patch, 34: tour.shortcut-2044407-34.patch, failed testing. View results

Status: Needs review » Needs work

The last submitted patch, 38: tour.shortcut-2044407-38.patch, failed testing. View results

mkindred’s picture

Updated patch:

  1. Moved from config/install to config/optional
  2. Made the tour a bit more accurate... after a quick refresher on shortcuts

Status: Needs review » Needs work

The last submitted patch, 43: tour.shortcut-2044407-43.patch, failed testing. View results

rakesh.gectcr’s picture

Issue tags: +Nwdug_may18

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

Drupal 8.6.0-alpha1 will be released the week of July 16, 2018, which means new developments and disruptive changes should now 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.7.x-dev » 8.8.x-dev

Drupal 8.7.0-alpha1 will be released the week of March 11, 2019, which means new developments and disruptive changes should now be targeted against the 8.8.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.8.x-dev » 8.9.x-dev

Drupal 8.8.0-alpha1 will be released the week of October 14th, 2019, which means new developments and disruptive changes should now be targeted against the 8.9.x-dev branch. (Any changes to 8.9.x will also be committed to 9.0.x in preparation for Drupal 9’s release, but some changes like significant feature additions will be deferred to 9.1.x.). 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.1.x-dev

Drupal 8.9.0-beta1 was released on March 20, 2020. 8.9.x is the final, long-term support (LTS) minor release of Drupal 8, which means new developments and disruptive changes should now 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.

ridhimaabrol24’s picture

Assigned: mkindred » Unassigned
Status: Needs work » Needs review
Issue tags: -
FileSize
4.05 KB
3.5 KB

Fixed failed tests and added a test for the Shortcut Tour tips.

Status: Needs review » Needs work

The last submitted patch, 50: 2044407-50.patch, failed testing. View results

ridhimaabrol24’s picture

Status: Needs work » Needs review
FileSize
4.07 KB
740 bytes

Fixing failed tests.

ridhimaabrol24’s picture

Hi
I have made some changes to the patch #52. Replaced id and class with proper data-class.
Also I have removed the tip pointing to the main navigation menu because that is not the part of the Shortcuts page and it fails the tests as the corresponding element doesn't gets found on the shortcuts page.
Also added a tour tip to the "Add shortcuts" Link.

jibran’s picture

Status: Needs review » Needs work

Thank you @ridhimaabrol24 for working on the patch.

+++ b/core/modules/shortcut/tests/src/Functional/ShortcutTourTest.php
@@ -0,0 +1,51 @@
+  public static $modules = ['block', 'shortcut', 'tour'];

This property should be protected now.

ridhimaabrol24’s picture

Status: Needs work » Needs review
FileSize
3.98 KB
563 bytes

Thank you for the feedback @jibran. Made the changes.

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

Drupal 9.1.0-alpha1 will be released the week of October 19, 2020, which means new developments and disruptive changes should now be targeted for the 9.2.x-dev branch. For more information see the Drupal 9 minor version schedule and the Allowed changes during the Drupal 9 release cycle.

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

Drupal 9.2.0-alpha1 will be released the week of May 3, 2021, which means new developments and disruptive changes should now be targeted for the 9.3.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.3.x-dev » 9.4.x-dev

Drupal 9.3.0-rc1 was released on November 26, 2021, which means new developments and disruptive changes should now be targeted for the 9.4.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

manuel.adan’s picture

Issue tags: -Needs tests
FileSize
3.92 KB
1.4 KB

Accommodate later changes in tour configuration files. Simple diff provided, interdiff failed due changes in base code. Re-rolled.

Status: Needs review » Needs work

The last submitted patch, 59: 2044407-59.patch, failed testing. View results

manuel.adan’s picture

Status: Needs work » Needs review
FileSize
3.92 KB
1.31 KB

Fixes configuration entries order.

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

Drupal 9.4.0-alpha1 was released on May 6, 2022, which means new developments and disruptive changes should now 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.5.x-dev » 10.1.x-dev

Drupal 9.5.0-beta2 and Drupal 10.0.0-beta2 were released on September 29, 2022, which means new developments and disruptive changes should now 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.

smustgrave’s picture

Status: Needs review » Postponed
Issue tags: +Needs Review Queue Initiative

So this is now postponed as shortcut is going to be removed #3311180: [meta] Determine how to make Shortcut module more useful and maintainable

Also tour is update for consideration #3325445: [Policy] Remove tour module from core

But positive news if tour moves out it has less gates to go through in contrib.

Version: 10.1.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, which currently accepts only minor-version allowed changes. For more information, see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.