Closed (fixed)
Project:
Configuration Split
Version:
8.x-1.x-dev
Component:
User interface
Priority:
Normal
Category:
Plan
Assigned:
Unassigned
Reporter:
Created:
30 Mar 2017 at 07:59 UTC
Updated:
7 Sep 2017 at 14:05 UTC
Jump to comment: Most recent, Most recent file
Comments
Comment #2
adamzimmermann commentedComment #3
ssibal commentedPersonally I think "Graylist" is a good naming. I wouldn't change it.
Comment #4
eelkeblokWhat about "Split configuration" (blacklist) and "Overridden configuration" (gray list)? Together with the improved descriptions from [#2822974: Document greylist/blacklist differences in admin form] I'd say it couldn't get any clearer than that.
Comment #5
frederickjhHi!
Isn't the current graylist more like the .gitignore file used in git to say do not include these files in the repository?
Graylisting email means that the mail server receives an email from an email address that it has never seen before tells the sending server it is temporarily unavailable. If the mail server is configured properly it will try back after a wait period (it is in a spec somewhere). Spam mail servers will many times try the backup mail servers right away or the same server. After the first email from an email address gets through the graylisting their emails are accepted the first time.
The graylisting on this module is nothing like this.
I think that Ignore list is a better term for this. I also think that the help text should warn users that if the ignore configuration this way it will be lost when new code is deployed unless they in their deployment export this configuration split, so that it can then be reimported with the new configuration.
I would be interested to hear what others think about this.
Frederick
Comment #6
eelkeblokYes, "Gray list" is probably not the best name. Hence, this issue :)
The configuration is not being ignored (you'd want config_ignore module for that). It is split off into the split, like the black list. The only difference is when the same configuration items are present in the main sync directory; for black list, the configuration will be removed from the main sync. For gray list, the configuration will be kept as-is in the main sync. When importing, the configuration from the split will get priority over that in the sync. Hence my suggestion to call it "Overridden configuration", because that is what is happening.
Comment #7
johan.gant commented+1 for 'Ignore list' or similar suggested by frederickjh. 'Graylist' didn't make much sense to me at the start. Also, 'Ignore list' is the same in en-GB and en-US :)
Comment #8
eelkeblokLike I said in my previous comment, 'Ignore list' is very inaccurate. Maybe more so than Gray/grey list, which is "just" vague. "ignore" is plain wrong (sorry).
Comment #9
bircherI have to agree with @eelkeblok here, "ignore list" is for sure not a better name since it would be misleading. Nothing gets ignored here. Config Split is all about *not* ignoring anything.
I like "forked configuration" or "branched configuration" as suggested in #2822974. But maybe there is a better name yet..
I guess I would also keep (graylist) in parentheses since that has been the name now for almost a year.
Comment #10
megachriz+1 for the suggestion from eelkeblok in #4.
Here is a patch that implements that suggestion (though I renamed "Graylist" to "Configuration overrides" instead of "Overridden configuration"). The patch also includes suggestions for changes to the descriptions of form elements on the configuration page. This removes any references to the terms 'blacklist' and 'graylist' on the page. I did not change the machines names of the fields for now: I only made changes to the interface texts, so we can purely focus on that.
Comment #11
eelkeblokCool. I was just thinking the last time I looked into this issue that it needed more patches :) Hopefully I'll have a chance to review next wednesday.
Comment #12
bircherHi MegaChriz, thanks for the patch.
Unfortunately, "Configuration overrides" is not going to work.
Configuration overrides is another concept that already exists in Drupal 8s configuration management.
And yes thank you for not changing the machine name. That would require a migration for the existing configuration and with over 3k sites using the module, we are not going to change schemas for cosmetic reasons. (That is also why I would leave "graylist" in parentheses)
Comment #13
remydenton commentedJust brainstorming here, what about something like 'Hard Overrides' and 'Soft Overrides' (in place of Blacklist and Graylist, respectively)? That's at least consistent with the idea that they both do a similar thing, one is just a little more forcefully than the other.
True, the concept of 'Configuration overrides' already exists, but the word "override" aptly describes what config split does (i.e. general configuration is used by default, but any configuration that is part of the active split takes precedence over, or overrides, those defaults. Blacklisted config just means there's no default value allowed).
The other idea I have is to keep the existing "colorful" naming, which is not entirely bad, and add a very short description to the headings themselves like this:
Blacklist (Removes default config)
Graylist (Overrides default config)
Comment #15
bircherThanks everyone for the contribution and the discussion.
So in the end I went with:
Blacklist (Forked Configuration / Hard Overrides)
Graylist (Branched Configuration / Soft Overrides)
The reason being that none of the names are perfect or convey what happens. But I have gotten used to graylist by now and I want to arrive at a conclusion of this issue. I also added more help texts in the hope of explaining it better.
Feel free to contribute to the documentation or open another issue with a patch for better help text.
Comment #16
alexmoreno commentedsomething like Overrides would be years light bettername, IMHO. I just started to work with this module and blacklist intuitevely tells you the opposite to what it does:
"blacklist this modules on this environment",
when what it really does is "whitelist" those modules and install them on the environment you are specifying. Am I wrong here?
My two cents :-)
Comment #17
frederickjh@alexmoreno, I have to agree that the terms Blacklist and Graylist are confusing. In my opinion they never should have been used as they do not fit the use case. In the end if this project holds on to them they will continue to cause confusion at best, at worse they will lower the rate of adoption.
Blacklist, Whitelist and Graylist are terms from the email server realm. White list means this list of email address always get through. Blacklist means this list of email addresses never get through. Graylist is not really a list, unless you consider all the email addresses that a mailserver has had prior contact with a list. Graylist means if the server has never seen you before you need to wait a bit before I will accept your mail, plus you must follow the standard rules regarding a "temporarily unavailable" response. Which of course spammer do not.
How these terms even remotely should be applied to Configuration Splits is beyond me. Just because the developer has gotten use to terms does not mean that the users will. I will have a look at the documentation and see what I can contribute there in an effort to bring clarity to this issue.
Comment #19
bircherSo I adapted the labels *again*.
I guess it depends on the perspective with the names. I understand that if you try out this module because you want to set up a development module and you read on some blog or heard somewhere that config_split can help you with that and you just try it out without being bothered to turn on the help or read the readme that "blacklist" and "graylist" make no sense. And I do recognise that "blacklist this modules on this environment" could come to mind.
However, this is just one perspective. A split is a configuration filter and in the perspective of how the filter works when exporting the configuration is what gave rise to the names blacklist and graylist. Because they behave very much like @frederickjh explains how email servers use the terms:
A configuration which is "blacklisted" on export it is filtered out, is not written to the sync storage. When it is "graylisted" on export it is only passed through to the sync storage if it exists there already otherwise it is blacklisted.
Anyway, I changed it to "Complete Split" and "Conditional Split". Those terms might not be immediately familiar to everyone but at least they do not conjure up false associations. Yet the terms are accurate enough to convey some meaning and work in both above mentioned perspectives. I left blacklist and graylist in parentheses so that it would be easier to understand when reading old blog posts or documentation.
Comment #20
bircherThe name change is now part of the 8.x-1.1 release.
If you think the help text in the module needs to change please open a new issue and provide a patch.
And thank you also in advance already for helping to improve the documentation in the documentation section here on drupal.org.
Comment #21
eelkeblok(Sorry, comments crossed. If you would still like me to open a new issue, let me know).
Sounds good. Sorry, but while we're at it I have some more suggestions to clean up the screen. Patch is attached (against HEAD, so it serves as an interdiff as well). I hope you're not too tired of this issue yet :)
- I removed the terms in parentheses from the field label, I would suggest those should be kept as clean as possible.
- To reduce further confusion, I've only left the terms graylist and blacklist (in the descriptions), to help users familiar with the old terminology. The other alternatives I've dropped, since it feels like trying to shower users in terms to hope one of them sticks and makes the concept click for them. I doubt that is helpful.
- I've tried to make the descriptions a bit more concise. Same reasoning, basically. Lets try and come up with a short and concise explanation of what it does.
- I've changed some of the labels for the fields within the fieldgroups, since they were partially redundant (both "Modules" and "Blacklist" within the "Blacklist" fieldgroup) and tried to make labels and descriptions more consistent.
What I'm not entirely sure of is what the text fields do. I've now given them the label "Filter rules", since IIRC they make it possible to filter entire "classes" of configuration items. If specific configuration items are listed, I believe there is no difference between it and the select box (correct me if I'm wrong).
Comment #22
eelkeblokComment #24
bircherThanks a lot of the contribution.
I switched the blacklist and graylist labels around and changed the "filter".
Yes the textarea and the select box are inputs for the same configuration key. The text area just lists everything that was not in the select box (so for example configuration names with * wildcards or configuration that is not active on the site.)
Comment #25
eelkeblokAh, that makes a lot of sense. Thanks for accepting the patch.