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

CommentFileSizeAuthor
#75 interdiff_64-75.txt5.43 KBvsujeetkumar
#75 2938803-75.patch7.16 KBvsujeetkumar
#73 Afterpatch.png617.51 KBRinku Jacob 13
#73 BeforePatch.png641.76 KBRinku Jacob 13
#65 Screenshot 2021-04-30 at 13.01.14.png58.64 KBGauravvvv
#65 Screenshot 2021-04-30 at 12.58.15.png65.47 KBGauravvvv
#64 interdiff_62-64.txt1.42 KBvsujeetkumar
#64 2938803-64.patch3.63 KBvsujeetkumar
#62 2938803-62.patch3.58 KBranjith_kumar_k_u
#53 2938803-52.patch3.59 KBspitzialist
#51 2938803-51.patch3.06 KBspitzialist
#48 2938803-48.patch3.1 KBspitzialist
#48 2938803_interdiff_45-48.txt1015 bytesspitzialist
#45 2938803-45.patch1.9 KByepa
#45 patch-45.png46.96 KByepa
#41 after-patch-23_8.7.x.png56.68 KByepa
#41 before_8.7.x.png55.4 KByepa
#36 screenshot-finalise-wording.png58.33 KBbrahmjeet789
#28 after.png104.8 KBmarkconroy
#28 before.png124.66 KBmarkconroy
#23 2938803-23.patch756 bytesDavid_Rothstein
#16 2938803-16.patch1 KBharsha012
#15 Screen Shot 2018-01-29 at 16.39.32.png20.52 KBmarkconroy
#14 2938803-14-which-to-that.patch1.03 KBDavid_Rothstein
#14 interdiff-2.txt876 bytesDavid_Rothstein
#14 2938803-14.patch1.03 KBDavid_Rothstein
#14 interdiff-1.txt872 bytesDavid_Rothstein
#10 status-html-label.png53.21 KBckrina
#5 install-screen-before_0.png42.39 KBckrina
#5 install-screen-after_0.png34.46 KBckrina
#3 2938803-3.patch1.03 KBDavid_Rothstein
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

markconroy created an issue. See original summary.

markconroy’s picture

David_Rothstein’s picture

Title: Finalise the wording of the warning message on the install screen » Finalise the wording about the Umami profile on the install screen
FileSize
1.03 KB

Based 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.

David_Rothstein’s picture

Status: Active » Needs review
ckrina’s picture

ckrina’s picture

Issue summary: View changes
markconroy’s picture

I 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.

ckrina’s picture

Issue summary: View changes
markconroy’s picture

From @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.

ckrina’s picture

Status: Needs review » Needs work
FileSize
53.21 KB

Thanks @markconroy and @David_Rothstein!

+++ b/core/profiles/demo_umami/demo_umami.info.yml
@@ -1,6 +1,6 @@
+description: "Install an example website that shows off Drupal's capabilities.<br><div role='contentinfo' aria-label='Warning message' class='messages messages--warning'>This creates a site which is intended for demonstration purposes.</div>"

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.

David_Rothstein’s picture

I 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."

Yeah, adding "some of" back in sounds good to me - I may have removed too many words there :)

Discussed in the UX meeting, we agreed on changing the warning text to "This creates a site that is intended..."

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.

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.

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.

ckrina’s picture

I'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.

markconroy’s picture

Okay, 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.

David_Rothstein’s picture

OK, 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)?

markconroy’s picture

Priority: Normal » Major
FileSize
20.52 KB

We need to remove the <strong> tags from the profile name, so it doesn't render them on the Status Report page.
html rendered on 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.

harsha012’s picture

Status: Needs work » Needs review
FileSize
1 KB

fixed as per #15

Status: Needs review » Needs work

The last submitted patch, 16: 2938803-16.patch, failed testing. View results

David_Rothstein’s picture

One slight concern I have with moving from this warning text (which my patch above had):

This creates a site that is intended for demonstration purposes.

To this (from #15):

This profile is intended for demonstration purposes only.

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.

markconroy’s picture

Hi 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.

ckrina’s picture

Status: Needs work » Postponed

This 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.

larowlan’s picture

Status: Postponed » Active

Blocker is in

David_Rothstein’s picture

Priority: Major » Normal
Status: Active » Needs review
Issue tags: -Umami beta blocker
FileSize
756 bytes

With 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.

navneet0693’s picture

I am agreed to the wordings suggested by @David_Rothstein, I am leaving this to 'Needs Review' to be reviewed by others too, but RTBC ;-)

markconroy’s picture

Status: Needs review » Reviewed & tested by the community

LGTM

Thanks.

The last submitted patch, 14: 2938803-14.patch, failed testing. View results

The last submitted patch, 14: 2938803-14-which-to-that.patch, failed testing. View results

markconroy’s picture

FileSize
124.66 KB
104.8 KB

Before patch:

After patch:

Gábor Hojtsy’s picture

Status: Reviewed & tested by the community » Needs work

I am a bit mixed about this change. Two thoughts:

  1. "This" looks odd. The warning only shows when you have the profile selected, so what else would the warning be about? We don't have "This" for field descriptions or anything similar because it is evident what the description is about (not that element but this element :).
  2. With the removal of "only" the *warning* message looks like an *informational* message to me now.

So I would at least remove "This" => "Creates a site intended for demonstration purposes". The "only" vs. warning probably needs a bit of discussion.

David_Rothstein’s picture

I 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).

With the removal of "only" the *warning* message looks like an *informational* message to me now.

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) :)

markconroy’s picture

Issue tags: +dclondon
Gábor Hojtsy’s picture

In 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.

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.

Eli-T’s picture

Status: Needs work » Closed (duplicate)

Closing as addressed by #2938185

David_Rothstein’s picture

Status: Closed (duplicate) » Needs work

The patch here still applies (with some offset). That other one is a different issue.

brahmjeet789’s picture

Status: Needs work » Needs review
FileSize
58.33 KB

@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

Eli-T’s picture

My 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.

PunamShelke’s picture

Assigned: Unassigned » PunamShelke
yepa’s picture

working on at #DrupalEurope

Sutharsan’s picture

Unassigning 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.

yepa’s picture

Assigned: PunamShelke » Unassigned
Status: Needs review » Reviewed & tested by the community
FileSize
55.4 KB
56.68 KB

It seems right after applying patch #23.
Screenshot before:
before
Screenshot after applying patch:
screenshot after

Gábor Hojtsy’s picture

@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?

lauriii’s picture

Status: Reviewed & tested by the community » Needs review
longwave’s picture

I 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.

yepa’s picture

The profile selection page without the warning on Umami :

screenshot

And the patch.

Status: Needs review » Needs work

The last submitted patch, 45: 2938803-45.patch, failed testing. View results

markconroy’s picture

That last screenshot looks much cleaner than the ones with the warning wrapper.

I think I'd edge towards that approach as well.

spitzialist’s picture

Due to the removed warning, one test failed:

Drupal\FunctionalJavascriptTests\Core\Installer\Form\SelectProfileFormTest::testUmamiProfileWarningMessage
Error: Call to a member function isVisible() on null

/var/www/html/core/tests/Drupal/FunctionalJavascriptTests/Core/Installer/Form/SelectProfileFormTest.php:127

ERRORS!
Tests: 1, Assertions: 0, Errors: 1.

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.

The last submitted patch, 45: 2938803-45.patch, failed testing. View results

Status: Needs review » Needs work

The last submitted patch, 48: 2938803-48.patch, failed testing. View results
- codesniffer_fixes.patch Interdiff of automated coding standards fixes only.

spitzialist’s picture

Status: Needs work » Needs review
FileSize
3.06 KB

I've readded the test that I removed in comment #48 and so tried to fix the test that failed in comment #50. Please review.

Status: Needs review » Needs work

The last submitted patch, 51: 2938803-51.patch, failed testing. View results

spitzialist’s picture

Tried to fix the test that failed in comment #51. Please review.

longwave’s picture

Status: Needs work » Reviewed & tested by the community

Looks good.

lauriii’s picture

Status: Reviewed & tested by the community » Needs review
Issue tags: +Needs product manager review

We should update the issue summary with the proposed solution, and after that get a product manager to review it.

volkswagenchick’s picture

Issue tags: +fldc19, +sfdug, +dcnj19

Tagging for upcoming contribution days.

volkswagenchick’s picture

Issue tags: +midcamp2019

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.

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.

ranjith_kumar_k_u’s picture

The last patch failed to apply on 9.2, so re-rolled for 9.2

Status: Needs review » Needs work

The last submitted patch, 62: 2938803-62.patch, failed testing. View results

vsujeetkumar’s picture

Status: Needs work » Needs review
FileSize
3.63 KB
1.42 KB

Fixed test, Please have a look.

Gauravvvv’s picture

The warning message is hidden now. Adding before and after patch screenshot for reference.

longwave’s picture

Title: Finalise the wording about the Umami profile on the install screen » Remove the warning about the Umami profile on the install screen
Issue summary: View changes
Status: Needs review » Reviewed & tested by the community
Issue tags: -Needs issue summary update, -Novice

Updated 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.

longwave’s picture

Status: Reviewed & tested by the community » Needs work

Actually, the updated test could do with a little improvement:

+++ b/core/tests/Drupal/FunctionalJavascriptTests/Core/Installer/Form/SelectProfileFormTest.php
@@ -119,19 +119,27 @@ protected function refreshVariables() {
+    $page->selectFieldOption('profile', 'standard');
+    $profile = $page->find('css', 'label[for="edit-profile-standard"]')->getText();
+    $this->assertTrue(($profile == 'Standard'));

This would be simpler as just

$this->assertSession()->optionExists('profile', 'Standard');

repeated for each profile option.

vsujeetkumar’s picture

Status: Needs work » Needs review

@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.

longwave’s picture

Ah yeah that only works for select, maybe we can just do

    $this->assertSession()->fieldExists('Standard');
    $this->assertSession()->fieldExists('Minimal');
    $this->assertSession()->fieldExists('Demo: Umami Food Magazine (Experimental)');

?

longwave’s picture

Not 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.

longwave’s picture

Status: Needs review » Needs work

In 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.

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.

Rinku Jacob 13’s picture

FileSize
641.76 KB
617.51 KB

Verified and tested updated patch #53 and patch #64
applied successfully.

markconroy’s picture

Thanks 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.

vsujeetkumar’s picture

Status: Needs work » Needs review
FileSize
7.16 KB
5.43 KB

@markconroy As mentioned in comment #71, Removed the JavaScript test, Patch given for 9.2.x, Please have a look and advise.

longwave’s picture

Status: Needs review » Reviewed & tested by the community

Thanks!

markconroy’s picture

Looks good, thanks @vsujeetkumar

Gábor Hojtsy’s picture

I 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.

markconroy’s picture

Thanks @Gábor Hojtsy

Looks like this one is remaining at RTBC and ready to be committed.

  • lauriii committed 62e06d8 on 9.3.x
    Issue #2938803 by David_Rothstein, spitzialist, vsujeetkumar, yepa,...

  • lauriii committed d3d41a4 on 9.2.x
    Issue #2938803 by David_Rothstein, spitzialist, vsujeetkumar, yepa,...
lauriii’s picture

Version: 9.3.x-dev » 9.2.x-dev
Status: Reviewed & tested by the community » Fixed

Discussed 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!

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.