When you arrive upon Configure site, this will be your first experience with the large amount of description that Drupal has. With this patch I intend to clean it a bit up.
Removing "To configure your website, please provide the following information." seems like fill out this form please. It is filler content, which the user doesn't actually need to read.
Site e-mail address
Changed "The From address in automated e-mails sent during registration and new password requests, and other notifications. (Use an address ending in your site's domain to help prevent this e-mail being flagged as spam.)"
To " From this address automated e-mails such as registration information will be sent. Use an address ending in your site's domain to help prevent this e-mail being flagged as spam."
The referral to from seems a bit weird, also several examples are not required.
Administrator account
Changed "The administrator account has complete access to the site; it will automatically be granted all permissions and can perform any administrative activity. This will be the only account that can perform certain activities, so keep its credentials safe."
To "The administrator account can perform any administrative activity."
It seemed rather excessive to explain it has access to the site and is able to perform any administrative activity. I don't think it makes sense to explain it can only do certain things, as we give the user no context as to what - also keeping credentials safe is something we don't have to mention.
E-mail address:
Changed"All e-mails from the system will be sent to this address. The e-mail address is not made public and will only be used if you wish to receive a new password or wish to receive certain news or notifications by e-mail."
To "All system related e-mails will be sent to this e-mail address." as it would confuse to put from in the message as you just filled in a from in the above form, which also related to system messages.
The disclaimer "The e-mail address is not made public and will only be used if you wish to receive a new password or wish to receive certain news or notifications by e-mail."" seems only appropriate to be presented to one registering on a site, not installing the site itself.
| Comment | File | Size | Author |
|---|---|---|---|
| #16 | site.configuration.descriptions.cleanup.patch | 2.62 KB | Bojhan |
| #13 | site.configuration.descriptions.cleanup.patch | 2.62 KB | Bojhan |
| #12 | site.configuration.descriptions.cleanup.patch | 2.64 KB | Bojhan |
| #12 | After_new_patch.png | 15.12 KB | Bojhan |
| #5 | site.configuration.descriptions.cleanup.patch | 2.55 KB | Bojhan |
Comments
Comment #1
Bojhan commentedRemoved a lot, but I think by rewriting we could probably remove and make certain clearer. Didn't tackle the others yet since I want to reach consensus on these one.
Comment #2
xanoAwesome :) Minor thiny: I'd remove the description of the administrator's e-mail address, because IMO telling him or any other user where his e-mail address is being used for is redundant information. We should remove this from the user register/edit form as well (but keep the privacy information there), but that is something for another issue.
Comment #3
Bojhan commentedSo after discussing this on IRC with Xano_ we came to some more arguments to remove "All system related e-mails will be sent to this e-mail address.", the idea of "system" is rather abstract and unless given a lot of context such as what kind of system mails will be send which depends again on configuration it is rather meaningless.
Also an argument could be made, that the likelihood that someone will alter his e-mail on this information is rather silly - and if one gets e-mails he can always change his address. If the goal of this text is to inform the user about such functionality as system mails, it won't be able to do that with just a few sentences.
Anyone else has thoughts on this?
Comment #4
dries commentedRe #2 and #3: I think it is OK to remove that remaining sentence.
Great clean-up. Tagging.
Comment #5
Bojhan commentedRemoved. The fields in server settings could probally do a cleanup to, but I will perseve that for a follow up - since that needs more discussion.
Comment #6
agentrickardSome notes:
This inverts normal English usage by putting the preposition first, and makes it very awkward. Better:
Flagged as spam by what or whom? Better:
This is a circular definition and has no value. I think the original text was better. Why would we not give a security warning about credentials here?
I think removing this is confusing, since we need to tell people what this form element is for. Here's an attempted replacement.
Comment #7
xanoBut then again, what are system reports? Everywhere on the internet e-mail addresses are used for seeking contact with users or to notify them of events using automated messages. More concrete than this isn't possible, because the installer has no way of knowing what kind of contact possibilities or automated messages are available.
Comment #8
agentrickard@Xano
We can debate the wording. My point is that you cannot leave that as the only field without a description element.
Comment #9
xanoWhy not? Using descriptions for the sake of descriptions is rubbish. We should only use them when they actually add something useful.
Comment #10
Bojhan commentedagentrickard: I agree on your first notion "Automated e-mails, such as registration information, will be sent from this address."
Also on "Use an address ending in your site's domain to help prevent your site's automated e-mails from being flagged by spam filters."
All the others are a question of what do you want to remove, and keep. Looking at the information value, one could argue that both that I removed contain little value. As Xano said its a bit of Drupals curse, adding description text for the sake of adding description text. It shouldn't be necessary with just good labeling and common sense.
Comment #11
agentrickardFair enough. If we fix the first two, I will concede the last one. But we can't use the circular 'administrator' definition in item 3.
Comment #12
Bojhan commentedSo changed point #1,#2. And for 3# I spoke with quite a few people about it, and it came down to that general idea of a administer account that is able to do administrative duties. Any description to describe that it has administrative privileges is rather silly. Hence why I removed it, making the title of the field more "out there".
Comment #13
Bojhan commentedChanged "Use an address ending in your site's domain to help prevent your site's automated e-mails from being flagged as spam"
To "Use an address ending in your site's domain to help prevent these e-mails from being flagged as spam"
Comment #14
Bojhan commentedComment #15
yoroy commentedGreat. Just went through this with bojhan in IRC, that last tweak came from there. Do it!
Comment #16
Bojhan commentedfixed the " " to ' '
Comment #17
webchickI had mentioned in passing on IRC that the first description looked like it should be in single quotes, but had missed the word "site's" later on. So I think #16 will fail. :)
Committed #13 to HEAD. Thanks!
Comment #18
xano"Use an address ending in your site's domain to help prevent these e-mails from being flagged as spam"
This sentence contains a textual error, since "these e-mails" refers to something that doesn't exist in this context. What e-mails? No e-mails have been mentioned, so there can be no reference to any.
Comment #19
yoroy commentedXano: previous sentence in the same description defines "these" emails… see screenshot in #12
Comment #20
xanoMust have missed that. My apologies.
Comment #21
andypostThis commit have break a HEAD install process so rollback is needed or #471824: Install broken - cant create account #1
Comment #22
webchickAnd that, boys and girls, is why you should always wait for the testing bot to come back, no matter how "trivial" the patch. :)
Andypost spotted one too many lines in there that got removed ($form['admin_account']['account']['#tree'] = TRUE;). Added that back in, and it looks like HEAD installs again.
Tentatively switching testing bot back on...
Comment #23
Bojhan commentedhah, I told you we needed to roll back! (for completely different reasons though :P) My mistake, sorry!