Problem/Motivation

that suggests the user put the site into Maintenance mode. In working on a different issue I noticed this and figured it could be a quick ui improvement.

Steps to reproduce

Proposed resolution

Only display the instruction 'Put your site into maintenance mode' when the site is not in maintenance mode.

Remaining tasks

#48. Add a check mark when in maintenance mode is on
Add a new 'after' screenshot

User interface changes

Before with maintenance mode on. Also, after with maintenance mode off.

After with maintenance mode on

API changes

Data model changes

Release notes snippet

Issue fork drupal-2099099

Command icon 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:

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

darrenwh’s picture

I think a better option would be to omit this as a step opposed to striking it out as it is not a required task.

yurtboy’s picture

makes sense. I could make the patch do that instead if it is worth it.

yurtboy’s picture

uploaded new patch to remove that line if TRUE

yurtboy’s picture

rpayanm’s picture

Issue summary: View changes
Status: Active » Needs review

rpayanm’s picture

Status: Needs review » Reviewed & tested by the community

Status: Reviewed & tested by the community » Needs work

The last submitted patch, 4: update-php-suggestion-2099099-4.patch, failed testing.

darrenwh’s picture

Re-rolling this patch

darrenwh’s picture

Status: Needs work » Needs review

Status: Needs review » Needs work

The last submitted patch, 9: update-php-suggestion-2099099-9.patch, failed testing.

Status: Needs work » Needs review
opdavies’s picture

Status: Needs review » Reviewed & tested by the community

#9 works for me.

rpayanm’s picture

Looks good.

darrenwh’s picture

Do this need to back ported to D7?

opdavies’s picture

It would need to be fixed in 8.0.x or 8.1.x first and then changed to 7.x, although there is a "needs backport to D7" tag that you can add if it needs backporting.

Status: Reviewed & tested by the community » Needs work

The last submitted patch, 9: update-php-suggestion-2099099-9.patch, failed testing.

rpayanm’s picture

Reroll

darrenwh’s picture

Status: Needs review » Reviewed & tested by the community

This looks good

alexpott’s picture

Version: 8.0.x-dev » 8.1.x-dev
Status: Reviewed & tested by the community » Postponed

This is not eligible during beta according to https://www.drupal.org/core/beta-changes.

darrenwh’s picture

This is a pity really, we have put a degree of effort into continually re-rolling it, this was created as part of code sprints in 2013 in Drupal Con in Prague and is endemic of the reasoning behind the continued delay of D8, not so sure if this is typical, but I feel whats the point in putting in this effort if its going to be put on the back burner? :(

darrenwh’s picture

Title: Update.php suggestion: if site is in maintenance mode then strikeout the line » DbUpdateController.php suggestion: if site is in maintenance mode then strikeout the line

Changing Title

Version: 8.1.x-dev » 8.2.x-dev

Drupal 8.1.0-beta1 was released on March 2, 2016, which means new developments and disruptive changes should now be targeted against the 8.2.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.2.x-dev » 8.3.x-dev

Drupal 8.2.0-beta1 was released on August 3, 2016, which means new developments and disruptive changes should now be targeted against the 8.3.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.3.x-dev » 8.4.x-dev

Drupal 8.3.0-alpha1 will be released the week of January 30, 2017, which means new developments and disruptive changes should now be targeted against the 8.4.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.4.x-dev » 8.5.x-dev

Drupal 8.4.0-alpha1 will be released the week of July 31, 2017, which means new developments and disruptive changes should now be targeted against the 8.5.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.5.x-dev » 8.6.x-dev

Drupal 8.5.0-alpha1 will be released the week of January 17, 2018, which means new developments and disruptive changes should now be targeted against the 8.6.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.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.

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.

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.

Version: 9.3.x-dev » 9.4.x-dev

Drupal 9.3.0-rc1 was released on November 26, 2021, which means new developments and disruptive changes should now be targeted for the 9.4.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.4.x-dev » 9.5.x-dev

Drupal 9.4.0-alpha1 was released on May 6, 2022, which means new developments and disruptive changes should now be targeted for the 9.5.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.5.x-dev » 10.1.x-dev

Drupal 9.5.0-beta2 and Drupal 10.0.0-beta2 were released on September 29, 2022, which means new developments and disruptive changes should now be targeted for the 10.1.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 10.1.x-dev » 11.x-dev

Drupal core is moving towards using a “main” branch. As an interim step, a new 11.x branch has been opened, as Drupal.org infrastructure cannot currently fully support a branch named main. New developments and disruptive changes should now be targeted for the 11.x branch, which currently accepts only minor-version allowed changes. For more information, see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

quietone’s picture

Title: DbUpdateController.php suggestion: if site is in maintenance mode then strikeout the line » f site is in maintenance mode omit instruction to put site in maintenance mode in DbUpdateController.php suggestion: i
Issue summary: View changes
Status: Postponed » Needs review
FileSize
1.74 KB
76.81 KB
72.29 KB

This seems reasonable so I updated the patch and added screenshots to the IS.

quietone’s picture

This should be better

quietone’s picture

Title: f site is in maintenance mode omit instruction to put site in maintenance mode in DbUpdateController.php suggestion: i » If site is in maintenance omit instruction to put site in maintenance mode in DbUpdateController.php

tedbow made their first commit to this issue’s fork.

tedbow’s picture

Component: update.module » system.module

I was going to say this needs test but was easier to add it.

Switch to system.module because it is not in update.module(why I found this issue)

smustgrave’s picture

Status: Needs review » Reviewed & tested by the community
Issue tags: +Needs Review Queue Initiative

Easy to test.

Applied MR 4524
Put site into maintenance mode
Verified line wasn't in update.php
Took out out of maintenance mdoe
Verified line was there

quietone’s picture

I'm triaging RTBC issues.

I looked at this late last night and after reading the IS and comments I don't see anything left to do. And thanks to @tedbow for adding a test. I ran the test locally without the fix and does indeed fail.

1) Drupal\Tests\system\Functional\UpdateSystem\UpdateScriptTest::testSuccessfulUpdateFunctionality with data set #0 (true)
Behat\Mink\Exception\ResponseTextException: The text "Put your site into maintenance mode" appears in the text of this page, but it should not.

/var/www/html/vendor/behat/mink/src/WebAssert.php:811
/var/www/html/vendor/behat/mink/src/WebAssert.php:279
/var/www/html/core/modules/system/tests/src/Functional/UpdateSystem/UpdateScriptTest.php:867
/var/www/html/core/modules/system/tests/src/Functional/UpdateSystem/UpdateScriptTest.php:701
/var/www/html/vendor/phpunit/phpunit/src/Framework/TestResult.php:728

Leaving at RTBC.

lauriii’s picture

I'm not sure I agree we should be omitting the text about maintenance mode from the list when maintenance mode is enabled. To me, this page looks like a static list that describes the recommended steps for updating Drupal. I would not expect it to change depending on what steps I've taken before.

quietone’s picture

Issue summary: View changes

I'm triaging RTBC issues.

Reading the previous comment made me look at the IS again. The first image is now out of date and I am going to remove it. The screenshots to look at are in the "User interface changes" section.

poker10’s picture

Regarding #20, would not it be better from the usability point of view to have that point checked, or highlighted some other way to be clear, that the point is done? I also understand this text as a static guide, so I would not expect some points missing from it.

quietone’s picture

Issue summary: View changes
Status: Reviewed & tested by the community » Needs review
Issue tags: +Usability

For me, #46 and #48 imply that this is a won't fix.

I will ask in #ux for guidance.

smustgrave’s picture

Status: Needs review » Postponed (maintainer needs more info)

So should this be closed?

quietone’s picture

Issue summary: View changes
Status: Postponed (maintainer needs more info) » Needs review
Issue tags: +Needs usability review

Lets get an opinion for a usability review to resolve this.

rkoller’s picture

Status: Needs review » Needs work
Issue tags: -Needs usability review

Usability review

We discussed this issue at #3386130: Drupal Usability Meeting 2023-09-15. The direct link to the recording of the meeting is: https://youtu.be/2bqTj97QiJ8?si=6-TmlJHwXvMVVtWJ&t=1260

For the record, the attendees at the usability meeting were @AaronMcHale, @benjifisher, @rkoller, @shaal, and @worldlinemine.

If you want more feedback from the usability team, a good way to reach out is in the #ux channel in Slack.

At first apologies for the belated comment. @quietone brought up the issue on the #ux channel last Friday. That issue looked quite familiar, so I did some digging in past issues before the meeting and it turned out we've already discussed it in September last year, where @quietone brought up the issue for the first time, but somehow we've failed to comment on the issue after the meeting. :( I've spent the weekend to watch the recording and re-familiarize with the issue. In the following a summary of the conclusions from back then.

There was a clear consensus among the attendees that simply hiding step 3 in case the requirement of an active maintenance mode is met is probably not the right thing to do here. Due to the fact you are having a numbered (ordered) list it might be a source for potential confusion if in one scenario (maintenance mode active) that list has three steps while in the other scenario (maintenance mode inactive) that very same list has four steps instead. That might be potentially problematic in the context of for example support questions referencing step 3 or 4.
The consensus what approach to take was in line with the suggestion made in #48, instead of hiding step 3 add a simple green checkmark or text illustrating that the requirement is met. On the other hand simply closing the issue as suggested in #50 would be problematic as well, without an indication like the suggested checkmark and having step 3 still in leaves the uncertainty for people with a small working memory if the maintenance mode was really already set or not.
We've also discussed adopting the pattern used in the Verify requirements step in the installe. But the problem as noted in #46 is, that the only requirement that is possible to be automatically tested in that list is step 3, the other steps are just recommended calls to action. Therefore doing anything more than just adding a checkmark would be probably not worth the effort.

Aside that it might be probably a good idea to rework the micro copy of the Drupal database update page in general in a follow up issue. For example it isn't clear at all what does Update your files (as described in the handbook page linked above). in step 4 actually refer to?
The upgrading handbook link it points to doesn't contain any clues in regards of "Update your files". If you search for update file or update your files you have no match - the linked https://www.drupal.org/updating-and-upgrading-drupal-core was last updated on the 5th of December 2017. It might make sense to review if that page might need an update as well. At least as a resource in the context of the provided link on the Drupal database update it is not that helpful at the moment.
On a side note, directional instructions on the Drupal database update page like "steps above" pointing to the handbook page should be avoided. It is not advised to utilize any directional instructions/language that requires the reader to see the layout or design of the page (for example https://styleguide.mailchimp.com/writing-for-accessibility/).
But all of those points are out of the scope for this issue and should better be tackled in follow-up issue(s).

I'll remove the Needs usability review tag and change the status back to Needs work

quietone’s picture

Issue summary: View changes

@rkoller, thanks for responding so quickly!

I have updated the remaining tasks to indicate a check mark is to be added. And I made the followup for the item in the last paragraph, #3414666: Improve text on database update page

quietone’s picture

Issue summary: View changes