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.
Comment | File | Size | Author |
---|---|---|---|
#77 | interdiff_76-77.txt | 1.51 KB | ridhimaabrol24 |
#77 | 2040823-77.patch | 3.86 KB | ridhimaabrol24 |
#76 | interdiff_74-76.txt | 807 bytes | ridhimaabrol24 |
#76 | 2040823-76.patch | 4.17 KB | ridhimaabrol24 |
#74 | interdiff_68-74.txt | 4.06 KB | ridhimaabrol24 |
Issue fork drupal-2040823
Show commands
Start within a Git clone of the project using the version control instructions.
Or, if you do not have SSH keys set up on git.drupalcode.org:
Comments
Comment #1
nickgs CreditAttribution: nickgs commentedFirst 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
Comment #2
nickgs CreditAttribution: nickgs commentedNot sure why my patch didn't get submitted for testing but switching this to needs review.
Thanks.
Nick
Comment #3
larowlanThanks so much for working on this - these tours are starting to take shape!
'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'?
Trailing white space
Can we frame this along the lines of 'Use this button to add a new menu to store a collection of menu links'?
Perhaps 'You can configure the placement of a menu on your site by visiting the Block administration page/'?
Comment #4
nickgs CreditAttribution: nickgs commentedAwesome, 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
Comment #5
lisarex CreditAttribution: lisarex commentedI 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.”
Comment #6
lisarex CreditAttribution: lisarex commentedSo, 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?
Comment #7
nick_schuch CreditAttribution: nick_schuch commentedTour needs tests since we now have #2028535
Comment #8
lisarex CreditAttribution: lisarex commentedGoing 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!
Comment #9
clemens.tolboomThis 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 :-/
Comment #10
rliworking on this.
Comment #11
rliAdding the test now.
Comment #12
floydm CreditAttribution: floydm commentedFixed intro comment in the test that referenced views_ui.
Comment #13
pameeela CreditAttribution: pameeela commentedJust made a few small changes. New patch and interdiff attached.
Comment #14
clemens.tolboomTest is missing in #13
Comment #15
pameeela CreditAttribution: pameeela commentedOops! 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.
Comment #16
nielsonm CreditAttribution: nielsonm commentedLooks good, great job.
Comment #17
batigolixThis 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
Comment #18
nick_schuch CreditAttribution: nick_schuch commentedThis patches updates the path to a route and uses the basic class for test coverage.
Comment #19
nick_schuch CreditAttribution: nick_schuch commentedComment #21
nick_schuch CreditAttribution: nick_schuch commentedComment #23
nick_schuch CreditAttribution: nick_schuch commentedHere we go. Time for green!
Comment #25
nick_schuch CreditAttribution: nick_schuch commented23: 2040823-23-tour-menu-page.patch queued for re-testing.
Comment #27
nick_schuch CreditAttribution: nick_schuch commented23: 2040823-23-tour-menu-page.patch queued for re-testing.
Comment #28
nick_schuch CreditAttribution: nick_schuch commentedComment #29
pameeela CreditAttribution: pameeela commentedNew patch and interdiff. Makes content updates and adds a tip for Settings tab per #17
Comment #31
pameeela CreditAttribution: pameeela commentedUpdates test coverage to exclude nth-child element which is unsupported. Should sort the fail.
Comment #32
pameeela CreditAttribution: pameeela commentedComment #33
bendev CreditAttribution: bendev commentedHello,
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
Comment #34
pwolanin CreditAttribution: pwolanin commentedre: 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
Comment #37
rodrigoaguilera@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
marking also as novice
Comment #38
jorgegc CreditAttribution: jorgegc commentedI am working on the changes guys.
Comment #39
jorgegc CreditAttribution: jorgegc commentedUploading patch for review.
Comment #40
benjy CreditAttribution: benjy commentedNone of this is needed if $tips and $permissions are configured it all happens in the base class.
Comment #41
jorgegc CreditAttribution: jorgegc commentedMade changes as per suggestions in #40 and also renamed the yaml file to replace the underscore with a hyphen.
Comment #42
benjy CreditAttribution: benjy commentedDon't think we need this.
Comment #43
jorgegc CreditAttribution: jorgegc commentedNice catch! Updated patch and interdiff.
Comment #44
benjy CreditAttribution: benjy commentedLooks good.
Comment #45
webchickSo 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.
Comment #46
benjy CreditAttribution: benjy commentedIt'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.
Comment #47
webchickAgreed. :( 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.
Comment #48
mgiffordComment #54
Electric Doorknob CreditAttribution: Electric Doorknob as a volunteer commentedI'm picking this up as part of our #Nashville2018 sprint.
Comment #55
Electric Doorknob CreditAttribution: Electric Doorknob as a volunteer commentedThis 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.
Comment #56
Electric Doorknob CreditAttribution: Electric Doorknob as a volunteer commentedComment #58
jhodgdonThanks 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.
Comment #59
Electric Doorknob CreditAttribution: Electric Doorknob as a volunteer commentedThanks for the feedback! I'll reroll this with some additional related Menu module tour items that I noted in 56
Comment #60
benjifisherGenerally, the "Active" state means that there is not yet a patch on the issue. I think this issue should be marked NW.
Comment #63
volkswagenchickTagging for DrupalNorth 2019
Comment #64
vacho CreditAttribution: vacho at Skilld commentedRefactoring some the code for made more standard.
Comment #66
ravi.shankar CreditAttribution: ravi.shankar at OpenSense Labs commentedI have re-rolled patch #64 on Drupal 8.9.x-dev
Comment #68
owenpm3 CreditAttribution: owenpm3 at Mobomo commentedI've added a patch with the config/optional noted in #58. Sounds like this could still need some work.
Comment #70
Ankush_03Comment #72
ridhimaabrol24 CreditAttribution: ridhimaabrol24 at Srijan | A Material+ Company for Drupal India Association commentedPatch added for Drupal 9.1
Comment #74
ridhimaabrol24 CreditAttribution: ridhimaabrol24 at Srijan | A Material+ Company for Drupal India Association commentedFixed failed tests.
Comment #76
ridhimaabrol24 CreditAttribution: ridhimaabrol24 at Srijan | A Material+ Company for Drupal India Association commentedComment #77
ridhimaabrol24 CreditAttribution: ridhimaabrol24 at Srijan | A Material+ Company for Drupal India Association commentedFixing failed test case
Comment #78
ridhimaabrol24 CreditAttribution: ridhimaabrol24 at Srijan | A Material+ Company for Drupal India Association commentedComment #84
smustgrave CreditAttribution: smustgrave at Mobomo commentedPatch 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.
Comment #87
rpayanmComment #88
smustgrave CreditAttribution: smustgrave at Mobomo commentedAppears there were some errors.
Comment #91
quietone CreditAttribution: quietone at PreviousNext commentedThis 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.