Add tour integration for Menu admin page

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

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/'?

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

Tour needs tests since we now have #2028535

+++ 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 :-/

working on this.

Adding the test now.

Fixed intro comment in the test that referenced views_ui.

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

Test is missing in #13

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.

Looks good, great job.

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

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

Here we go. Time for green!

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

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

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

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

Hello,

I would like to start contributing to D8 and I found multilingual to be a nice one to start with.

I have installed a D8 and started to configure it for FR and EN.

The translation of content type is ok. I have some problems to translate the menu items. I arrived to this post. I would like to see the "Tour for menu admin" so that I can test it and see if it is clear an apply it. The tour module is enabled. Should I install this patch to be able to start (and actually see the tour" ?

thanks

re: menu link translation see: #2256521: [META] New plan, Phase 2: Implement menu links as plugins, including static admin links and views, and custom links with menu_link_content entity, all managed via menu_ui module

@bendev
Yes, you can apply this patch and follow the tour

the test need annotation to be detected as such instead of getInfo() and at least a setUp function and some actual tests.
Is as simple as the following example

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this->adminUser = $this->drupalCreateUser(array('administer content translation', 'access tour'));
    $this->drupalLogin($this->adminUser);
  }

  /**
   * Tests Content translation tour tip availability.
   */
  public function testContentTranslationTour() {
    $this->drupalGet('admin/config/regional/content-language');
    $this->assertTourTips();
  }

marking also as novice

I am working on the changes guys.

Uploading patch for review.

+++ b/core/modules/menu_ui/src/Tests/MenuTourTest.php
@@ -0,0 +1,71 @@
+  /**
+   * {@inheritdoc}
+   */
+  protected function setUp() {
+    parent::setUp();
+    $this->adminUser = $this->drupalCreateUser(array('administer menu', 'access tour'));
+    $this->drupalLogin($this->adminUser);
+  }
+
+  /**
+   * Tests menu tour tip availability.
+   */
+  public function testMenuOverviewTour() {
+    $this->drupalGet('admin/structure/menu');
+    $this->assertTourTips();
+  }

None of this is needed if $tips and $permissions are configured it all happens in the base class.

Made changes as per suggestions in #40 and also renamed the yaml file to replace the underscore with a hyphen.

+++ b/core/modules/menu_ui/src/Tests/MenuTourTest.php
@@ -0,0 +1,49 @@
+  /**
+   * An admin user with administrative permissions.
+   *
+   * @var \Drupal\user\UserInterface
+   */
+  protected $adminUser;

Don't think we need this.

Nice catch! Updated patch and interdiff.

Looks good.

So pursuant to #1921152-109: META: Start providing tour tips for other core modules., I want to make sure we have a plan/strategy in place before going too nuts on these Tours. Marking postponed as a result.

However, I will say that I think this area would definitely benefit from a Tour, especially deeper into the menu interface. "What is show as expanded?" etc. So we likely will end up just expanding this one a bit to cover more of the menu admin interface.

It's a bit of shame that @jorgegc spent most of his day on this issue if there was a known disagreement with them moving forward.

We should probably postpone all child issues to stop anymore wasted effort.

Agreed. :( I spoke to him about it in person. Very sorry, I just didn't feel comfortable committing one of these when there doesn't seem to be alignment between the docs/UX team on what we should be doing here.

I'm back at my apartment now; I'll go postpone the other issues to make sure the dependencies are clear.

I'm picking this up as part of our #Nashville2018 sprint.

This patch builds on the previous patch for this issue, and attempts to use the tour to contextualize the purpose of the Menu Admin page for new site admins, give an example of its use, and lead toward the Add and Edit menu forms.

Further work is required, especially on the Menu Edit page and Link Add/Edit pages.

Thanks for the patch! As I noted on #1921152-146: META: Start providing tour tips for other core modules., the new tour needs to go into the config/optional directory under menu_ui, not config/install.

Thanks for the feedback! I'll reroll this with some additional related Menu module tour items that I noted in 56

Generally, the "Active" state means that there is not yet a patch on the issue. I think this issue should be marked NW.

Tagging for DrupalNorth 2019

Refactoring some the code for made more standard.

I have re-rolled patch #64 on Drupal 8.9.x-dev

I've added a patch with the config/optional noted in #58. Sounds like this could still need some work.

Patch added for Drupal 9.1

Fixed failed tests.

Fixing failed test case

Patch or MR doesn't apply anymore
The last patch or MR doesn't apply to the target branch, please reroll the code so that it can be reviewed by the automated testbot.

Appears there were some errors.

This extension is being deprecated, see #3336033: [Meta] Tasks to deprecate Tour module. It will be removed from core and moved to a contrib project, #3376099: [11.x] [Meta] Tasks to remove Tour.

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.

PHPUnit test fails

Observed test failures , fixed those & also done some change in test w.r.t to standard

Now MR is mergeable now, Please review, moving NR

Hi @pooja_sharma,

I installed and enabled the Tour module with 2.0.x-dev on my Drupal 10 site. After reviewing and applying your MR!17, it seems the MR is currently not working on the Admin menu pages, particularly the Structure > Menu page.

Please see the attached file for reference.

I'm moving this to 'Needs work' for now.

Thank you.

I have checked MR 17 is working fine, on drupal 11 attached screenshot, can you please share on which specific version of Drupal 10 as earlier tour module is part of core, may be you need to test qith MR 3061 for Drupal 10.

Since 2.0.x has no release we can add this config to the giant update hook.

Going to mark this one.