Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.
Problem/Motivation
Initially the issue was to improve the warning text that appears when you select the Umami profile in the installer.
In #42 onwards there is consensus that the warning is no longer needed as we already advertise the Umami profile as a "Demo" and "(Experimental)", so the issue is now to remove the warning label from Umami.
Remaining tasks
User interface changes
Before
After
Comment | File | Size | Author |
---|---|---|---|
#75 | interdiff_64-75.txt | 5.43 KB | vsujeetkumar |
#75 | 2938803-75.patch | 7.16 KB | vsujeetkumar |
#73 | Afterpatch.png | 617.51 KB | Rinku Jacob 13 |
#73 | BeforePatch.png | 641.76 KB | Rinku Jacob 13 |
#65 | Screenshot 2021-04-30 at 13.01.14.png | 58.64 KB | Gauravvvv |
Comments
Comment #2
markconroy CreditAttribution: markconroy as a volunteer and at Annertech commentedComment #3
David_Rothstein CreditAttribution: David_Rothstein as a volunteer commentedBased on the parent issue, I think this is supposed to be about all the install screen wording (including the profile description too), not just the warning message?
In any case, here's a possible patch. See #2938189-9: [META] Finalise the wording of the messages in installer, toolbar and on the status report page for discussion and screenshots.
Comment #4
David_Rothstein CreditAttribution: David_Rothstein as a volunteer commentedComment #5
ckrinaComment #6
ckrinaComment #7
markconroy CreditAttribution: markconroy as a volunteer and at Annertech commentedI think we need a qualificiation within the text, so that it doesn't promise everything - "Install an example website that shows off Drupal's capabilities.".
Maybe something like:
"Install an example website that shows off some of Drupal's capabilities."
Besides that tiny gripe, this looks really good. Thanks.
Comment #8
ckrinaComment #9
markconroy CreditAttribution: markconroy as a volunteer and at Annertech commentedFrom @andrewmacpherson here https://www.drupal.org/project/drupal/issues/2938185#comment-12446801
Accessibility review:
1. Remove the role="contentinfo" and aria-label="Warning message". This role is intended for regions which contain information about the page as a whole. It's not appropriate for this warning message which applies to a particular selection among the radio buttons.
2. The warning message isn't conveyed to assistive technology. On page load, the warning message has CSS display:none from the States API :visible. So the information isn't conveyed to assistive tech. The warning needs to be conveyed to AT users when the Umami radio is selected.
Possible approaches:
Use an aria-describedby to programatically associate the Umami radio button with the warning message. This means the umami radio button will be described by TWO elements (the warning first, then the form #description) while the Standard and Minimal will be described by one element (the form #description).
Use role="alert" or aria-live="assertive" on the warning message (it must be on same element which has display:none toggled. This might not be a robust solution! In theory this should cause the message to be announced immediately when it becomes visible, but in practice some screen readers don't give priority to assertive ARIA live regions yet. The message may not be announced. Needs testing.
Use Drupal.announce() to convey the message when it appears. This also needs testing, there's no guarantee it will be spoken. I expect some screen readers will treat the radio button's and aria-describedby as higher priority, and omit to annouce the warning.
My hunch is the first one will be the most reliable, but we'll see. I'd like to play around with these approaches with some screen readers.
Comment #10
ckrinaThanks @markconroy and @David_Rothstein!
Discussed in the UX meeting, we agreed on changing the warning text to "This creates a site that is intended..."
For the rest, people in the call said like the change was ok.
Anyway, I agree with @markconroy about not promising the moon. So +1 to "shows off some of Drupal's capabilities.".
But it was pointed out that the
< strong >
tag used to stand out the "Experimental" word appears in the Status page too and it shouldn't.Comment #11
David_Rothstein CreditAttribution: David_Rothstein as a volunteer commentedYeah, adding "some of" back in sounds good to me - I may have removed too many words there :)
It's a very minor point, but I slightly prefer "which" over "that" because it sounds a little better when you read it; otherwise you can get tongue-tied with the "this" and "that". (Some people think "that" is the only grammatically-correct choice for a sentence like this, but that is not actually the case. See https://www.merriam-webster.com/words-at-play/when-to-use-that-and-which.) But I think either would be fine.
Yes, probably needs to be fixed in #2822414: Redesign the 'install profile selection' installer screen to allow for experimental profiles and more information (to allow the experimental profile to be labeled on the install page without including it as part of the profile name). Or alternatively, don't display that word as part of the title at all, which I guess is one of the designs that has been proposed there also.
Comment #12
ckrinaI'm not a native language speaker, so I'll trust you all. :) (It was mentioned by It was suggested by @benjifisher in the UX meeting)
About the tag in the title, +1 to @David_Rothstein's suggestion to remove it since it is not in the final design chosen for the MVP.
Comment #13
markconroy CreditAttribution: markconroy as a volunteer and at Annertech commentedOkay, is this the text we are proposing at the moment:
Title
Umami Demo - Experimental
Description
This creates a site that is intended for demonstration purposes.
Warning
Install an example website that shows off some of Drupal's capabilities.
Comment #14
David_Rothstein CreditAttribution: David_Rothstein as a volunteer commentedOK, here's a new patch that adds "some of" (and I also changed "website" to "site" because I noticed that "site" is what is used in the Minimal profile description, so this should probably be consistent with that.)
And, a second patch that additionally changes "which" to "that". That way someone else can decide between them :) (Actually, I am now wondering if it is even better to just use neither word - could it simply be "This creates a site intended for demonstration purposes" instead?)
It sounds like there is still discussion ongoing about the profile title. Both "Food Magazine" and "Experimental" are important pieces of information, so if one or both of those is removed from the title, wouldn't it have to be added to the text somewhere else (e.g. the description)?
Comment #15
markconroy CreditAttribution: markconroy as a volunteer and at Annertech commentedWe need to remove the
<strong>
tags from the profile name, so it doesn't render them on the Status Report page.Title:
Demo: Umami Food Magazine (Experimental)
Warning:
This profile is intended for demonstration purposes only.
Description:
Install an example site that shows off some of Drupal's capabilities.
Comment #16
harsha012 CreditAttribution: harsha012 as a volunteer and at Red Crackle commentedfixed as per #15
Comment #18
markconroy CreditAttribution: markconroy as a volunteer and at Annertech commentedWe have this content now added to #2938185: When installing Umami, only show warning if 'Demo Umami' radio button is selected (and ensure that it is obvious that warning message only applies to the Umami profile), so I think we can probably close this issue.
I'll leave it open just for now, pending getting #2938185: When installing Umami, only show warning if 'Demo Umami' radio button is selected (and ensure that it is obvious that warning message only applies to the Umami profile) committed.
Comment #19
David_Rothstein CreditAttribution: David_Rothstein as a volunteer commentedOne slight concern I have with moving from this warning text (which my patch above had):
To this (from #15):
is that I wonder if the second gives people the impression that this isn't a "real" profile (i.e., that the option on the screen is itself just there for demo purposes, and that clicking on the radio button won't actually do anything)?
I do think they'll figure it out eventually, but I would not be surprised if some people hesitate briefly out of confusion -so that is why I went with the "creates a site" text originally.
Comment #20
markconroy CreditAttribution: markconroy as a volunteer and at Annertech commentedHi Ted,
I think what you are suggesting makes sense. Could you create a patch here #2938185: When installing Umami, only show warning if 'Demo Umami' radio button is selected (and ensure that it is obvious that warning message only applies to the Umami profile) to change that wording? Once we get an accessibility review on that issue, this one here will also be closed.
Comment #21
ckrinaThis issue's suggestion are going to be addressed in #2938185: When installing Umami, only show warning if 'Demo Umami' radio button is selected (and ensure that it is obvious that warning message only applies to the Umami profile). Marking as postponed until that one is closed, and the probably we'll be able to close this one.
I'll move @David_Rothstein suggestion to the other issue so it doesn't get lost.
Comment #22
larowlanBlocker is in
Comment #23
David_Rothstein CreditAttribution: David_Rothstein as a volunteer commentedWith that issue committed, I think the one remaining thing here is to discuss my idea from #19.
Here is a patch for that, with "This creates a site intended for demonstration purposes" as the final wording of the warning. (Note that this also makes things a bit more consistent with the proposed wording in #2938800: Finalize wording for Toolbar warning message.)
However, since most of the wording was finalized in the other issue (and this is just a small tweak) I think this can definitely be downgraded and shouldn't block a beta release or anything like that.
Comment #24
navneet0693 CreditAttribution: navneet0693 as a volunteer and at QED42 commentedI am agreed to the wordings suggested by @David_Rothstein, I am leaving this to 'Needs Review' to be reviewed by others too, but RTBC ;-)
Comment #25
markconroy CreditAttribution: markconroy as a volunteer and at Annertech commentedLGTM
Thanks.
Comment #28
markconroy CreditAttribution: markconroy as a volunteer and at Annertech commentedBefore patch:
After patch:
Comment #29
Gábor HojtsyI am a bit mixed about this change. Two thoughts:
So I would at least remove "This" => "Creates a site intended for demonstration purposes". The "only" vs. warning probably needs a bit of discussion.
Comment #30
David_Rothstein CreditAttribution: David_Rothstein as a volunteer commentedI see what you're saying, but whereas we can get away with incomplete sentences for a field description sometimes, I don't think we can for a standalone message. It should be a complete sentence.
So if the dangling "this" looks wrong, I guess another option would be "This profile creates a site intended for demonstration purposes". It's a little longer, but it's consistent with other warnings (e.g. "This action cannot be undone" for Drupal's standard confirmation message).
Any reason you're worried about it here but not in #2938800: Finalize wording for Toolbar warning message? Removing "only" here just matches what was done there.
That said, you are not wrong about that making it a bit more of an informational message - personally, that's where I'd like to see it go anyway (#2945378: Finalize design for Toolbar warning message, and change the install screen design to match) :)
Comment #31
markconroy CreditAttribution: markconroy as a volunteer and at Annertech commentedComment #32
Gábor HojtsyIn my mind the lack of "this" does not make the sentence incomplete. Neither of the other text use "this" on this screen, because it is always evident which option they are about. It is not "Save and continue this installation" or "Pick this option to install with commonly used features pre-configured."
I don't know why it feels like removing the "only" word here is not ok if it was in #2938800: Finalize wording for Toolbar warning message. It may be that the visual of it there is non-standard otherwise so it did not feel like needing to satisfy "being a warning". But if we want to make it an informational message, I don't think we should keep it a warning wrapper, because it does not line up conceptually.
Comment #34
Eli-TClosing as addressed by #2938185
Comment #35
David_Rothstein CreditAttribution: David_Rothstein as a volunteer commentedThe patch here still applies (with some offset). That other one is a different issue.
Comment #36
brahmjeet789 CreditAttribution: brahmjeet789 as a volunteer and at gai Technologies Pvt Ltd commented@David_Rothstein the last submitted ptach-23 applied cleanly , you can see the screenshot after applying patch i can see the changes in wording about the Ummai Profile so there is no ned to rework it again
Comment #37
Eli-TMy mistake @David_Rothstein - apologies.
It would be super helpful to update the issue to reflect the current status and rationale behind this change, maybe with new screenshots as those in the summary are totally outdated.
Comment #38
PunamShelkeComment #39
yepaworking on at #DrupalEurope
Comment #40
Sutharsan CreditAttribution: Sutharsan at LimoenGroen commentedUnassigning PunamShelke. Please respond if you are still working on this issue.
Because many people are working on/looking for issues marked Novice and DrupalEurope today at the Mentored Sprint, we ask people to not assign these issues to themselves today. But instead write a comment that they are started working and (if applicable) stopped working without a result.
Comment #41
yepaIt seems right after applying patch #23.
Screenshot before:
Screenshot after applying patch:
Comment #42
Gábor Hojtsy@lauriii asked me to review this again. I stand by my prior comments on the change:
- "This" looks superfluous, it is evidently about this option, we don't put "this" into any other description or field label
- Since the new message is more informational than a warning (in no small part due to the removal of "only" at the end), it now looks odd in the warning wrapper. Why is it a problem/issue that the site is for demonstration purposes? That is not explained. Then why display it as a problem?
Comment #43
lauriiiComment #44
longwaveI am not convinced we need the warning label at all. We already have "Demo" in the radio button and "example site" in the description, I don't think we need to re-iterate that for a third time with a scary-looking warning triangle.
Comment #45
yepaThe profile selection page without the warning on Umami :
And the patch.
Comment #47
markconroy CreditAttribution: markconroy as a volunteer and at Annertech commentedThat last screenshot looks much cleaner than the ones with the warning wrapper.
I think I'd edge towards that approach as well.
Comment #48
spitzialist CreditAttribution: spitzialist as a volunteer and at Unic commentedDue to the removed warning, one test failed:
I removed the test case completely as (in my opinion) it does not make sense to test the demo profile with a special case compared to the other options without the warning. No visible changes were made compared to patch and comment #45.
Comment #51
spitzialist CreditAttribution: spitzialist as a volunteer and at Unic commentedI've readded the test that I removed in comment #48 and so tried to fix the test that failed in comment #50. Please review.
Comment #53
spitzialist CreditAttribution: spitzialist as a volunteer and at Unic commentedTried to fix the test that failed in comment #51. Please review.
Comment #54
longwaveLooks good.
Comment #55
lauriiiWe should update the issue summary with the proposed solution, and after that get a product manager to review it.
Comment #56
volkswagenchickTagging for upcoming contribution days.
Comment #57
volkswagenchickComment #62
ranjith_kumar_k_u CreditAttribution: ranjith_kumar_k_u at Zyxware Technologies commentedThe last patch failed to apply on 9.2, so re-rolled for 9.2
Comment #64
vsujeetkumar CreditAttribution: vsujeetkumar at Srijan | A Material+ Company for Drupal India Association commentedFixed test, Please have a look.
Comment #65
Gauravvvv CreditAttribution: Gauravvvv at OpenSense Labs commentedThe warning message is hidden now. Adding before and after patch screenshot for reference.
Comment #66
longwaveUpdated the IS to match the recent discussion and with screenshots that match the latest patch.
Also removing "Novice" as there is nothing left for a novice to do here.
Marking RTBC for product manager review.
Comment #67
longwaveActually, the updated test could do with a little improvement:
This would be simpler as just
repeated for each profile option.
Comment #68
vsujeetkumar CreditAttribution: vsujeetkumar at Srijan | A Material+ Company for Drupal India Association commented@longwave I have worked on the above suggestion mentioned in #67, however its not working and gives the below error message.
"Select with id|name|label|value "profile" not found."
According to me its not select field, Please advise.
Comment #69
longwaveAh yeah that only works for select, maybe we can just do
?
Comment #70
longwaveNot even sure we need the test, it was added in #2938185: When installing Umami, only show warning if 'Demo Umami' radio button is selected (and ensure that it is obvious that warning message only applies to the Umami profile) when we added the warning, now we are removing the warning maybe we should just delete the test.
Comment #71
longwaveIn fact we already have multiple tests that exercise each of these options, anything that descends from InstallerTestBase will use one of the radio buttons to install the profile so this test can just be removed - we don't need to duplicate it. It was added separately here because of the JavaScript interaction with the warning, but now that has been removed we can also remove the JavaScript test.
Comment #73
Rinku Jacob 13 CreditAttribution: Rinku Jacob 13 at Zyxware Technologies commentedVerified and tested updated patch #53 and patch #64
applied successfully.
Comment #74
markconroy CreditAttribution: markconroy as a volunteer and at Annertech commentedThanks for working on this @longwave, @Rinku Jacob 13, @vsujeetkumar, @Gauravmahlawat, and others.
Looks like we are nearly there. As @longwave said, we now just need to remove the JS test that adds the message if the "Demo Umami" install profile is chosen, since we are no longer adding that message.
If someone can do that, then create a new patch (with interdiff), we can get this tested and await a framework manager sign-off.
Thanks.
Comment #75
vsujeetkumar CreditAttribution: vsujeetkumar at Srijan | A Material+ Company for Drupal India Association commented@markconroy As mentioned in comment #71, Removed the JavaScript test, Patch given for 9.2.x, Please have a look and advise.
Comment #76
longwaveThanks!
Comment #77
markconroy CreditAttribution: markconroy as a volunteer and at Annertech commentedLooks good, thanks @vsujeetkumar
Comment #78
Gábor HojtsyI don't know if people who felt strong before about the warning changed their minds or not. I don't think that is needed personally. You would fall into the "building off of Umami trap" after you installed it, not before. And the runtime still has the warning. So I think making trying Umami more welcoming is better. We don't want to scare people off trying Umami, just scare them off of building on top of it. And that is at a later stage.
Comment #79
markconroy CreditAttribution: markconroy as a volunteer and at Annertech commentedThanks @Gábor Hojtsy
Looks like this one is remaining at RTBC and ready to be committed.
Comment #82
lauriiiDiscussed with @catch to make sure the release managers don't have concerns on this change.
Committed 62e06d8 and pushed to 9.3.x and 9.2.x. Thanks!