Problem/Motivation
I was noticing I had put in just abc123.cloudfront.net in the CDN mapping and didn't see any examples in the help text or any documentation of the format or recommendations. I took hints from #1115686: Add support for any type of file referenced in node bodies (currently only images) and the project homepage screenshot that it should have been with the protocol included.
http://abc123.cloudfront.net, the strange thing is the SSL mapping is on a different page and only shows up if you enable the support for it, but doesn't seem to need the mapping as long as that is checked off as SSL support the previous screen's http://abc123.cloudfront.net would be converted to https://abc123.cloudfront.net
Proposed resolution
- Move the SSL section below the mapping so the original mapping is in visual context.
- Explain the need of the protocol and how it will be replaced or allow for protocol less mappings(which may have previously worked)
- Explain the pattern in help text after the pipe
| - Explain what happens without the piped file extensions.
Remaining tasks
Decide which documentation pieces would be the right way forward.
User interface changes
Moving form fields to the same page.
API changes
Data model changes
Follow-up to #1115686: Add support for any type of file referenced in node bodies (currently only images)
| Comment | File | Size | Author |
|---|---|---|---|
| #16 | Screen Shot 2016-02-13 at 13.03.04.png | 11.32 KB | wim leers |
| #16 | cdn-mapping-ux-2667156-16.patch | 1.06 KB | wim leers |
| #13 | CDN.png | 45.83 KB | joelpittet |
| #10 | add_help_text_or-2667156-10.patch | 6.62 KB | joelpittet |
Comments
Comment #2
wim leershelp/admin-details-mode-pull-cdn-mapping.htmlalready contains documentation for this. Did you install the Advanced Help module, like the CDN module encourages?Comment #3
joelpittetWhy does it need the protocol if it just replaces it anyway?
Comment #4
joelpittetOh I avoid installing the advanced help module, it's hardly ever helpful and just one more module to install... I guess this may be the exception to the rule.
Comment #5
joelpittetI feel with some simple examples in the #description, it would help people get up and running a bit quicker.
Comment #6
wim leers#5: the whole point was to KISS, all those examples in the description make it super noisy. That's what the CDN module *used* to do (years ago) and then *that* was the problem :)
Comment #7
joelpittetYeah couldn't reproduce it working with what I had in the staging site.
KISS by installing another module to show help doesn't seem that simple.
I know they can be noisy, I use formtips to keep my UX tidy in admin from that noise.
Maybe even simply put some examples in a
placeholderattribute to keep it cleaner?And how about moving some of the 'Other' tab to the details? Is there a reason behind the separation?
Comment #8
wim leersYes, there is. 90% of people don't ever need to change something on the "Other" tab.
Comment #9
wim leersAnd https://www.drupal.org/project/formtips is apparently used by a mere 317 sites.
All this is exactly why I want to remove the UI altogether in the Drupal 8 port. Let people just edit YML files. Perhaps a minimal UI that only allows this mapping to be entered, and then strictly validates it. Need anything more? Modify the YML file. For the discussion about that, see #2294613-6: Port CDN to Drupal 8.
Comment #10
joelpittetI collapsed the "Other fields" and moved them to "Details".
Added a very simple placeholder (apparently they don't take line breaks, learned something)
Comment #11
joelpittet@Wim Leers formtips has some drawbacks, so I have a hacked version and offered to maintain it;)
Comment #12
joelpittetminimal UI sounds nice, the least you need to get something up and working, and all the 'advanced' in yaml config sounds nice to me.
Comment #13
joelpittetComment #14
wim leers#12:
Very glad to hear that you too like that approach, that's the confirmation I was hoping to get :)
#10: Hm… I'm not sure I want to do that. That's a massive UI change. It's been like this for years. I don't think I want to overhaul the CDN UI, TBH.
Comment #15
joelpittetThe UI should really just try to deal with the 90% use-case as easily and efficiently as possible. (percentage made up:P) Complicating the UI with edge cases and 'features' doesn't help the advanced use-cases nor the simple ones.
re #10 how about maybe I just move the SSL mapping stuff to details and leave the other stuff? Easier transition... and thoughts on placeholder?
Comment #16
wim leersYou only need the SSL mapping if you have to use a different domain name for SSL. Most CDNs use the same domain name for both HTTP and HTTPS. So for most CDNs, entering a protocol-relative URL in the "standard" CDN mapping is sufficient.
Placeholder++.
What about this?
Comment #17
wim leersNote that in D8, none of this is a problem anymore:

See #2294613-34: Port CDN to Drupal 8.
Comment #18
joelpittetThat looks like UI improvement for sure:)
Comment #20
wim leersThanks, @joelpittet! Committed #16.