Download & Extend

Improved error message for missing settings.php file

Project:Drupal core
Version:8.x-dev
Component:install system
Category:feature request
Priority:normal
Assigned:Unassigned
Status:needs work
Issue tags:Needs text review, Usability

Issue Summary

As written the error message for "missing settings.php" is confusing. The attached patch updates the text to read:

The file settings.php does not exist.
You must create a settings file before proceeding with the installation of Drupal. Copy the template settings file ./sites/default/default.settings.php to ./sites/default/settings.php.

The final para is also updated to read as follows:
Please fix the issues listed above and refresh your browser window. Additional information about installing Drupal is available in the file /INSTALL.txt.

Screen shots are available:
current: http://www.flickr.com/photos/emmajane/3601956533/
patched: http://www.flickr.com/photos/emmajane/3601956529/

AttachmentSizeStatusTest resultOperations
installer_settings_text.patch2.17 KBIdlePassed: 11901 passes, 0 fails, 0 exceptionsView details | Re-test

Comments

#1

Status:active» needs review

Updating status to "needs review."

#2

Tagging.

#3

Status:needs review» reviewed & tested by the community
Issue tags:-Needs usability review

This is a good improvement, we don't need to mention the INSTALL.txt here it only confuses the action part. I hope someone can finish the patch where a user doesn't have to rename anymore.

Marking this RTBC.

#4

Status:reviewed & tested by the community» needs work

This looks like a nice improvement!

As long as we're touching this message, can we please link the word "INSTALL.txt" to its file?

#5

Thanks webchick, apprently both me and catch missed the line you changed at the bottom. We probally need to talk a little bit more about it, here is a short part of IRC.

yoroy> I looked 3 times before seeing it
yoroy> The text in the red message is an improvement, the one underneath isn't
Bojhan> yoroy: I missed it to!
yoroy> this is one of the worst cases for an inline link no?
Bojhan> it takes you away from the installer, even I think - ohh it doesnt.
catch> install.txt = bad link.
yoroy> Bojhan: I mean the "refresh" action even
catch> I didn't notice that either looking at it earlier.
catch> yoroy: the refresh needs to be there to avoid completely relying on the browser no?
Bojhan> LOL
Bojhan> all three of us missed it?
catch> looks like it.
yoroy> catch: it needs to be there but having it as a simple link in the middle of the sentence is ehm sub-optimal
catch> yoroy: hah, yes true.

----
Proposed solution at University of Baltimore : instead of having it be a try-again link or anything, it beign a big button.

#6

Status:needs work» needs review

There you go!

AttachmentSizeStatusTest resultOperations
installer_settings_text_02.patch2.12 KBIdlePassed: 11885 passes, 0 fails, 0 exceptionsView details | Re-test

#7

Status:needs review» needs work

Crossposted with #5. Patch in #6 adds the link as proposed in #4.
Settings back to needs work for discussion opened in #5.
And having said that, I also find INSTALL.txt a bad link, but since it's a text file it's better than a generic "Installation instructions" because then people would be surprised that they leave the site. The coolest would be a "install.html", that looks the same as Garland, and contains the text of INSTALL.txt, but I see one could argue that is overkill.

#8

Status:needs work» needs review

The page title already says something needs to be done. We're in the middle of an installation process, IMO that doesn't need to be repeated. That default.settings.php is a template file (which might be mistaken for a theme-related template file) doesn't seem very important either. What do you think of this?

AttachmentSizeStatusTest resultOperations
installer_settings_text_03.patch1.98 KBIdleUnable to apply patch installer_settings_text_03.patchView details | Re-test

#9

I've updated the patch as follows:

1) File system error and settings error "Additional information" text now matches.
2) Additional INSTALL.txt info removed from the final para.
3) "Try again" link text changed to read, "proceed with the installation."
4) Removed the dead link for INSTALL.txt for the reasons that it would lead you away from the "pretty garland" to an unstyled wall of text.

See changes at: http://www.flickr.com/photos/emmajane/3604610209/

AttachmentSizeStatusTest resultOperations
installer_requirements_02.patch3.73 KBIdlePassed: 11885 passes, 0 fails, 0 exceptionsView details | Re-test

#10

Please fix the problems listed above and proceed with the installation.

  1. Please sounds like a suggestion, where this really is a necessity.
  2. If you omit the first part you have "Please proceed with the installation", which is weird, because the user should want to proceed by themselves, we shouldn't ask them to.

#11

@tstoeckler the word "please" does not reduce the instruction to being a suggestion, it is simply being polite. I encourage you to provide alternative wording if you are set against what is there currently. :)

#12

Status:needs review» needs work

"fix the problems above and try again." Seriously. "proceed with installation" is just using more expensive words to say the same, it's overly formal and we're already in installation mode so no need to re-use that word here.

Ommit needles words. Especially in the interface. We shouldn't aim to be as correct or complete as possible but give only just enough information for users to make a decision.

""Please fix the problems listed above and proceed with the installation"
"Fix the problems above and try again."
"Fix these problems and try again"

Do you see how much screen space this saves us without giving any less info?

Sorry to be a pain about this but Drupal is riddled with long-winded run on sentences and we really should move away from that.

#13

it is simply being polite

This has been my intention. It's bad enough things break down, so I figured we might as well say please to ease the pain instead of commanding the user what to do.

Sorry to be a pain about this but Drupal is riddled with long-winded run on sentences and we really should move away from that.

Np, you're right :)

#14

@yoroy saying "seriously" doesn't make you more right.

1) "Try again" has no meaning to me as part of a Web link. It directs me to repeat an action, but begs the question: Try what again? I didn't do anything to get that screen, I was simply proceeding through an installation and then it stopped for no apparent reason. Does "Try again" take me back to where I had to select a language? I have no idea. "Proceed" however, tells me that I am moving forward and will not have to repeat any actions.

2) I still see no issue with the word "please." Both options fit onto a single line of text, but the one that starts with "please" is more human. @xano's alternative message is probably the best to date. :)

#15

#16

Issue tags:+Usability

We have somebody installing d7 for the first time, stumbling over the 'proceed with installation' line in #652288: Improve installer usability:

#17

Current text: Please fix the problems listed above and proceed with the installation.
Suggested new text: 1. Fix the problems listed above. 2. Finish the installation. (link)

In my experience, it is easier to follow instructions with numbers. Instead of the word proceed, I suggest finish or complete.

#18

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