In our ongoing mission to improve Drupals performance by removing bits of text from the interface we have found another candidate :-) The maintanance mode admin screen has some room for improvements.

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

yoroy’s picture

maintenance mode copy

- The help text along the top does not make clear how this is related to the exposed functionality (I'd call this a bug)
- The description for the 'put in maintance mode' checkbox describes the exception first, default behavior second (not a bug, also not very elegant)
- The description below the text field for the message is redundant, doesn't add anything that's not contained in the label.

yoroy’s picture

Status: Active » Needs review
FileSize
2.71 KB
57.9 KB

Proposed in this patch:

Dries’s picture

- I'd have to double-check but I believe we committed a patch that automatically set Drupal in maintenance mode when running updates? Either way, we can ignore that for now.

- I don't think "Maintenance mode message" is self-explanatory. Maybe we can tweak the label a bit. Maybe we should make the title: "Message to show visitors when in maintenance mode". It is a bit long but it might work.

yoroy’s picture

Status: Needs review » Needs work

- Well, I navigated to maintanance mode directly and the 'If you are upgrading…" line just didn't make sense. It happening automatically whille updating doesn't mean we can leave this disconnect imo. I can see how we would have to rewrite that line though.

- Hmmm, true, could be more explicit. It is explained in the description for the checkbox but we shouldn't rely on that. I'll revisit it.

jhodgdon’s picture

I think the checkbox message should say "only", as in "Visitors will only see the maintenace mode message". Or something to that effect, to indicate they won't see the rest of the site.

I think if there is help text at the top of the screen, it should explain why you would want to use maint mode. Otherwise, just remove the text entirely. I don't think having it start with something about update.php is useful in the least, though. Very confusing.

yoroy’s picture

- Agreed on adding 'only", makes it clearer.
- Running update.php is the main reason for using this page, no? I still have to check what the flow is for updating though.

jhodgdon’s picture

Well, someone could conceivably decide to put their site in maint mode while they are copying in new versions of modules, uploading some stuff, updating some content types or views, modifying their theme, importing something big, running Services, etc. Or for making database backups.

I.e. not just to run update.php but more generally while they are updating their site. Let's not mention update.php, let's just say something like "to protect your site from being viewed and used by non-administrative users while you are making updates or backups"?

jhodgdon’s picture

Assigned: yoroy » Unassigned
Category: task » bug
Status: Needs work » Needs review
FileSize
3.02 KB

Here's a new patch. Screen shot coming shortly (I'm having trouble with uploads at the moment).

jhodgdon’s picture

FileSize
20.2 KB

Here's the screen shot.

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

The last submitted patch, 666170new.patch, failed testing.

Status: Needs work » Needs review
Issue tags: +Usability

Re-test of 666170new.patch from comment #8 was requested by aspilicious.

aspilicious’s picture

I think test bot is sick again...

jhodgdon’s picture

Yeah, I don't think that patch should have caused errors in the dblog module, unless some of those tests were specifically looking for text on the Maint Mode page. Which is possible, but not related to the dblog module, so unlikely.

lisarex’s picture

FileSize
2.96 KB
59.47 KB

OK, much better but I think the initial help text is too long and "normal site operation" sounds a bit scary. And we were eradicating overuse of "your site"...

Propose:

Use maintenance mode when making major updates, particularly if the updates could disrupt visitors or the update process. Examples include upgrading Drupal or modules, importing or exporting content, modifying a theme, modifying content types, and making backups.

jhodgdon’s picture

Status: Needs review » Reviewed & tested by the community

lisarex: Your wording is MUCH better. Let's get this one in.

webchick’s picture

Status: Reviewed & tested by the community » Needs work

One quick thing. We shouldn't use the word "Drupal" directly in user-facing text. You should use variable_get('site_name', 'Drupal') instead.

jhodgdon’s picture

That place where Drupal is being used is "...updating Drupal or modules"...

Saying site name will not work there.

lisarex’s picture

FileSize
2.94 KB

OK, changed to just say 'upgrading'.

I just hope people know that means upgrading modules, not just core.

jhodgdon’s picture

Status: Needs work » Needs review

setting status for test bot

jhodgdon’s picture

Status: Needs review » Reviewed & tested by the community

Assuming the test bot is happy, I'm happy too, and that pesky word "drupal" has been excised.

Status: Reviewed & tested by the community » Needs work

The last submitted patch, 666170c.patch, failed testing.

lisarex’s picture

FileSize
2.94 KB

Trying again... testbot, get with it!!! ;)

lisarex’s picture

Status: Needs work » Needs review

changing status.

cosmicdreams’s picture

#22: 666170d.patch queued for re-testing.

webchick’s picture

Version: 7.x-dev » 8.x-dev

We're in string freeze now. Let's look at this again in Drupal 8.

yoroy’s picture

Status: Needs review » Needs work

bye CVS, hello Git

drupal_was_my_past’s picture

Recreating patch from #22 as a git patch.

drupal_was_my_past’s picture

Status: Needs work » Needs review

Oops. Setting status to needs review.

jhodgdon’s picture

Status: Needs review » Reviewed & tested by the community

Thanks for the re-roll! This text was reviewed, revised, and accepted by at least three people previously, so I'm going to go ahead and mark it RTBC for Drupal 8 only (string change).

Dries’s picture

Status: Reviewed & tested by the community » Fixed

Committed to 8.x. Thanks.

drupal_was_my_past’s picture

Awesome.

Also, as a string change, should I generate a patch for 7.x or should it not go into 7.x for localization reasons?

jhodgdon’s picture

No, we can't put this into Drupal 7 at this point. It's not a big enough problem to incur the translation issues.

drupal_was_my_past’s picture

Got it. Thanks jhodgdon.

Status: Fixed » Closed (fixed)
Issue tags: -Usability

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