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

Problem/Motivation

Write tour integration for Menu admin page

Proposed resolution

Create tour yml files for required admin screens in admin/structure/menu.

Remaining tasks

Create patch for tour integration for primary Structure 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.

Comments

StatusFileSize
new1.21 KB
PASSED: [[SimpleTest]]: [MySQL] 57,061 pass(es).
[ View ]

First time core patch here... figured I could give this a go.

I think these tours, if used right, can provide a great experience for new Drupal users!

I hope this is helpful.

Thanks.

Nick

Status:Active» Needs review

Not sure why my patch didn't get submitted for testing but switching this to needs review.

Thanks.

Nick

Thanks so much for working on this - these tours are starting to take shape!

+++ b/core/modules/menu/config/tour.tour.menu.ymlundefined
@@ -0,0 +1,29 @@
+    body: 'Collection of tools for use with a particular menu. Rearrange menu link ordering, and various other configuration attributes. Click dropdown for available actions'

'Use the drop-button to perform operations on each menu including re-arranging menu link order, adding new menu links and changing the menu name'?

+++ b/core/modules/menu/config/tour.tour.menu.ymlundefined
@@ -0,0 +1,29 @@
+    attributes: ¶
...
+    attributes: ¶

Trailing white space

+++ b/core/modules/menu/config/tour.tour.menu.ymlundefined
@@ -0,0 +1,29 @@
+    body: 'Will allow you to create a new menu to store a collection of menu links'

Can we frame this along the lines of 'Use this button to add a new menu to store a collection of menu links'?

+++ b/core/modules/menu/config/tour.tour.menu.ymlundefined
@@ -0,0 +1,29 @@
+    body: 'This page lists the menus available on your site. Menus are a collection of links arranged in a hierarchy. The display of menus is accomplished by its corresponding block which is managed on the block administration page.'

Perhaps 'You can configure the placement of a menu on your site by visiting the Block administration page/'?

StatusFileSize
new1.19 KB
PASSED: [[SimpleTest]]: [MySQL] 57,113 pass(es).
[ View ]

Awesome, thanks for the review! I'm having fun learning how the tours work and creating these patches.

I think the changes you suggest make alot of sense. It simplifies the verbiage and makes it a bit more succinct. Question, do we want to include links in tour tips? Specifically for this issue, a link to the block administration page. Being that we have the link already on the page I am not sure we need it.

Attached is a rerolled patch incorporating your suggestions.

Thanks.

Nick

I didn't get a chance to create the patch, (I assigned the issue to myself but I guess I wasn't fast enough ;))

Here's our copy for this page, for comparison

tip 1
(Immediately under the page title)
Title: “Edit a menu link”
Body: “Use this page to edit an item in a menu.”
tip 2
(Immediately under “Parent link”)
Title: “Select a parent”
Body: “Menus can have more than one layer. Select the menu item that is in the layer above this one.”
tip 3
(Immediately under “Weight”)
Title: “Order menu item by weight”
Body: “Within a menu layer, items are listed by weight.”
Tip 4
(Immediately under “Save”)
Title: “Save your changes”
Body: “Click Save to apply your changes to the menu item.”

So, we have written tours for the following:
/admin/structure/menu/
/admin/structure/menu/admin/item/*/edit
/admin/structure/menu/manage/admin

Should this be a multipage tour?

Issue tags:+Needs tests, +Tour

Tour needs tests since we now have #2028535

Assigned:lisarex» Unassigned

Going to unassign myself since I don't know how much time I'll have to get back into this, but I will try to make it happen!

StatusFileSize
new1.25 KB
PASSED: [[SimpleTest]]: [MySQL] 58,483 pass(es).
[ View ]

+++ b/core/modules/menu/config/tour.tour.menu.yml
@@ -0,0 +1,29 @@
+      data-class: dropbutton-action

This was not working. The tip did not attach to the button.

Attached patch has step 3 fixed. I'm not sure why the selector was broken. I changed it into dropbutton-widget instead.

I changed the location too as that looks nicer.

As @nick_schuch adds this needs #2028535: Provide a TourTestBase class for use by core and contrib modules but I'm not sure whether that would have caught the selector problem.

The patch was build on http://tour.drutch.nl/ without using git commands. (no coding involved). I really could use some help building that site for the community :-/

Assigned:Unassigned» rli

working on this.

StatusFileSize
new2.57 KB
PASSED: [[SimpleTest]]: [MySQL] 58,418 pass(es).
[ View ]

Adding the test now.

StatusFileSize
new454 bytes
new2.56 KB
PASSED: [[SimpleTest]]: [MySQL] 58,782 pass(es).
[ View ]

Fixed intro comment in the test that referenced views_ui.

Issue summary:View changes
StatusFileSize
new1.25 KB
PASSED: [[SimpleTest]]: [MySQL] 60,178 pass(es).
[ View ]
new1.48 KB

Just made a few small changes. New patch and interdiff attached.

Status:Needs review» Needs work

Test is missing in #13

Status:Needs work» Needs review
StatusFileSize
new2.56 KB
PASSED: [[SimpleTest]]: [MySQL] 59,828 pass(es).
[ View ]

Oops! Updated patch attached (interdiff doesn't change).

Also realised I should have explained the changes. I made the first tip title sentence case to match the others, added a full stop in the second tip, and removed the hyphen from rearranging.

Status:Needs review» Reviewed & tested by the community
Issue tags:-Needs tests

Looks good, great job.

Status:Reviewed & tested by the community» Needs work

This doesnt seem ready to me.

a) I think we should not use words like "this button" or "this page". The tour tips will make clear what element is being referred to

b) There should be a tip on the Settings tab, so the user knows what can be found there

c) "Use the drop-button to perform operations on each menu including rearranging menu link order, adding new menu links and changing the menu name." . There are only 2 options in the drop button. There is no option to change the menu. But this can be done via the Edit menu drop down option

d) "Add a new menu" could be better "Add a menu". "New" is redundant here.

e) "You can configure the placement of a menu by visiting the block administration page." --> This is called the Block layout page now (at least at this moment). Can we have a link on there so that the users does not have to search for this page? Maybe it is also good to mention that one should enable a menu block first.

f) Check the menu_help function in menu.module for some additional information that could be used in this tour

Status:Needs work» Needs review
StatusFileSize
new2.58 KB
FAILED: [[SimpleTest]]: [MySQL] 63,411 pass(es), 5 fail(s), and 1 exception(s).
[ View ]
new2.22 KB

This patches updates the path to a route and uses the basic class for test coverage.

Issue tags:+Tour Content Review

Status:Needs review» Needs work

The last submitted patch, 18: 2040823-18-tour-menu-page.patch, failed testing.

Status:Needs work» Needs review
StatusFileSize
new2.5 KB
FAILED: [[SimpleTest]]: [MySQL] Unable to apply patch 2040823-21-tour-menu-page.patch. Unable to apply patch. See the log in the details link for more information.
[ View ]

Status:Needs review» Needs work

The last submitted patch, 21: 2040823-21-tour-menu-page.patch, failed testing.

Status:Needs work» Needs review
StatusFileSize
new2.51 KB
PASSED: [[SimpleTest]]: [MySQL] 64,370 pass(es).
[ View ]
new1.29 KB

Here we go. Time for green!

Status:Needs review» Needs work

The last submitted patch, 23: 2040823-23-tour-menu-page.patch, failed testing.

23: 2040823-23-tour-menu-page.patch queued for re-testing.

The last submitted patch, 23: 2040823-23-tour-menu-page.patch, failed testing.

23: 2040823-23-tour-menu-page.patch queued for re-testing.

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

StatusFileSize
new2.53 KB
FAILED: [[SimpleTest]]: [MySQL] 64,391 pass(es), 1 fail(s), and 0 exception(s).
[ View ]
new1.55 KB

New patch and interdiff. Makes content updates and adds a tip for Settings tab per #17

Status:Needs review» Needs work

The last submitted patch, 29: 2040823-menu-tour-29.patch, failed testing.

StatusFileSize
new2.73 KB
PASSED: [[SimpleTest]]: [MySQL] 64,391 pass(es).
[ View ]

Updates test coverage to exclude nth-child element which is unsupported. Should sort the fail.

Status:Needs work» Needs review