backdrop-issues
backdrop-issues copied to clipboard
backdrop
[UX] Display a Welcome page after upgrading Backdrop to the latest version
First, let me tell you a story. My experience upgrading to Bd 1.2 If the monkey had to suffer, so must you experience the pain. :p
It's an experience that shouldn't be too different from a normal user.
The drama: Promising candy but making them get it on their own
I upgrade to Backdrop 1.2 without a hitch.
Yay! btw, love that I only have to replace one folder, core, to upgrade. Less thinking on my part. I like stupid simple.
The biggest talk point I kept hearing was "Backdrop now comes with a rich text editor!" Sweet. So, I immediately went to edit an old post but saw nothing of the kind. The immediate thought was
huh? Oh no. Maybe I didn't upgrade correctly. T.T There's no real confirmation I upgraded successfully to 1.2.
I panic and check the Status Report page but it says "1.2.0"
Huh? What gives? T.T
Somehow I go to the module list page and notice a disabled module called CKEditor (expected "rich text editor" but being smarter than the average bear I drew the connection. Will average ppl as well? One day I hear "CKEditor" and another "Rich text editor")
I go on and enable it.
Oh ok. haha, I get it. I'm so silly. That's so simple ... now goes to edit a post WTF??? Where's my RTE? T.T Grrrrr..... I hate Back... this doesn't make any sense at all! I enabled the module. No errors thrown. There's no config link in the "CKEditor" section of the modules list.
Only after thinking a bit do I recall how it's done in Drupal and I figure that I may have to look at admin/config/content/formats to get my RTE.
NOTE: New users won't have old Drupal knowledge and habits to fall back on. For them, this could be game over and give them a TERRIBLE aftertaste with Backdrop. Ignore this if you're only catering to Drupal users
I then mess around with those settings, jump over other hurdles (#1202 how was I ever supposed to know about this? Sigh. I always turn on aggregation thinking it's the optimal way to speed up the site), and then finally get my RTE.
Why does this have to be so hard?!?! You really are part of the Drupal family!
At this point, I'm annoyed even though I was able to solve it on my own.
The problems: The two points of conflict
- Info dissemination: Since I heard a RTE was coming to Bd by default, I expected I wouldn't need to do anything once I upgraded. Nothing told me otherwise that I would need to enable a module. If I need to have old Drupal knowledge or go into forums/github to figure that info out, that's a UX fail already.
-
No config instructions Let's assume I already knew I needed to enable the core module. Fine, free pass. I enable it but Bd makes it seems like everything is fine afterwards. How am I suppose to know I need to go mess with text editors and formats? Moreso, since there's no "configure" link next to the CKEditor module section (in the module list)
Makes it seem like there's nothing more to be done.
The Plan:
End of rant.
No worries because... I. have. a. plan. ^_____^
Here's my solution. I propose that Bd displays a "Success!"/"Welcome"/"Walkthrough" page whenever the CMS is upgraded and Bd has added new and major features (I suppose you could also do it for all upgrades)
It'll be similar to the page you get whenever you upgrade Wordpress, except they use it mostly to hype up their new features. Instead, Bd can use this page to not only announce major features but how to make it work. Walk through users with what's new and what they need to do (if anything)
Imagine you upgrade to Bd 1.2 and immediately after running /update.php,
- it redirects you to a page that confirms you do have the latest version.
- you scroll down, and notice it mentions the RTE feature. It tells you that since you upgraded, it's not on by default and it goes on to inform you what you need to do exactly with links and all.
- as a bonus, if you scroll further down this page, you'll see a section that tells you of any major issues with the new Bd version (that section can dynamically update) since its release like #1202.
In this way, whenever you upgrade to a new version, you'll have all the relevant info you need right there and then (kinda like the browser module). No need to go to searching at forums or a page like this (barbaric) to see what's new or what you need to do.
What do you think, no good?
PS: We could even add a link to this Welcome page from the dashboard #495 for reference. PSS: hehe. Sorry for the long post but all monkeys like attention. OK, how about, "If I had more time, I would've made it shorter?" ^_^
@sutibun I like the sound of your proposal.
Maybe in our preparation for v1.3 we should 'walk through' all processes for a newbie starting on a Backdrop site, including using typical shared server hosting, and where to start with choosing a theme etc etc.
@Graham-72 I don't know about a whole walk though. The welcome page is meant more to introduce the changes for that version. We could always provide a link to the "Getting started with Backdrop" guide on backdropcms.org which will do the full walk through (which we'll need to create) ex:
Success! You now have backdrop 1.2
first things first, remember if this is your first time or if you ever get lost, check out the "getting started with Backdrop" where you can become a backdrop pro in less than 20 minutes… blah blah blah. Now here is what you need to know about Backsrop 1.2
1) Rich text editor
The need to know HTML like an animal is over. Now, you just point and click.… blah blah blah.
How this works
By default, this feature is disabled. To turn it on, here is what you do… go here… do this… then do that… simple as pie.
troubleshoot
nothing is perfect so here are the latest issues with this feature…
2) blah blah
Something like that.
What would be cool, but maybe more time intensive, is if on top there is a YouTube video giving an overview. I can easily imagine seeing quicksketch enthusiastically gushing over what's new. Nothing better than selling something with a human face. Moreso, since he works on it for hours. Will also add a human touch to Backdrop
I like this, I like it very very much.
But I'd not want a new page just for such notices, I'd say this just be a panel or a message on the dashboard that was suggested before.
In fact, I'd say looking at that Dashboard proposal, I'd suggest that @klonos start building one of his METAs at https://github.com/backdrop/backdrop-issues/issues/495 so we can get a clear idea of what we want/need for that to start happening.
In fact, I'd say the site status report page could actually be converted into said dashboard: prettify it and categorize and prune the information, and we'd be halfway there. See https://github.com/backdrop/backdrop-issues/issues/283#issuecomment-67791483
I like this idea. Especially the "Here's what's new ... You can give it a go by ..." thing. Will take considerable time to implement though I imagine.
@quicksketch made a few steps towards the idea in https://github.com/backdrop/backdrop-issues/issues/1210#issuecomment-141341230 (added a column to show editor used by formats plus a "CKeditor not enabled... here's what you need to do" message in the site status page). Good start! Thanx Nate.
@docwilmot sorry, I missed that...
In fact, I'd say the site status report page could actually be converted into said dashboard
Not a bad idea either. I like the status page and use it often, but I can see why it might not be considered "friendly" or "pretty".
As for the META-issue... sure. I always want to help as much as I can (especially people like yourself that make our wishes/ideas/mockups reality). My only enemy is time. Will try to allocate as much as I can this weekend and get it done.
Trying to gather my thoughts…
When you upgrade Backdrop, what is the point of the Welcome page?
-
Clearly confirm you have successfully updated Backdrop to the latest version. Currently, you only have the following: "No pending updates"
Not exactly the best confidence booster for someone new. When I see the above, I always question whether the upgrade process ran smoothly. - Announce what new modules/features the latest version has. We can not assume the user keeps up with the latest Backdrop development. Nor should we expect her to dig that info out from forums, github, etc. It makes sense to centralize and present all the changes as she is upgrading. (In the same way, it's convenient and useful to install modules from within your website)
- Inform the user how the new features work AND how to configure, if necessary, the new core modules. Had this been implemented in 1.2, the Welcome page would've informed me that the Rich Text Editor feature is disabled by default, followed by what to do (along with links to the necessary pages) I would've been spared the back and forth.
- List the issues found with the latest Backdrop version. Imagine if there was a panel on the sidebar that dynamically lists discovered bugs with links to the proper GitHub page where you can dig in deeper.
How the Welcome page may appear
The Welcome page doesn't need to be complicated. For the most part, it's a static page. Here's a quick mockup.
Big Picture: How it all works together
During the upgrade process
Now how this ideally works goes something like this:
-
You download and install the latest Backdrop version on your server as usual.
-
Next, you go to /update.php and update the database. If there is something wrong, you remain in the first screenshot (all the way on top) and deal with any error messages.
However, if nothing goes wrong, you are redirected to the Welcome page.
-
You read over the new changes and make any necessary configurations. You also glance over the sidebar to see what bugs are coming up that you need to be aware of.
-
Since your upgrade was a success, the Welcome page is useless at this point so you click away. (Notice that at no point did you even need to leave your site)
After the upgrade process is all said and done
Let's say by accident you clicked away from the Welcome page or you've noticed some upgrade troubles. If later you want to refer to the Welcome page. you'll ideally go to the Dashboard page https://github.com/backdrop/backdrop-issues/issues/495#issuecomment-139957730 and find the reference link pointing to the Welcome page. Click and you're back on it.
Anyway, that is how I foresee the Welcome page working from A to Z.
I just stumbled across this very old issue and think that the recent additions of #495 (Add a dashboard) and #3994 (Welcome to Backdrop CMS block on dashboard) might have made it possible for some easy wins to improve the upgrade process. Also, the upcoming recent news block #3566 on the dashboard will provide another opportunity to communicate with the end user about new features.
Maybe now is a good time to rethink this problem and what is possible/helpful.
NOTE: We could use the Dashboard Plus module as a place to experiment with something. I created an issue there. https://github.com/backdrop-contrib/dashboard_plus/issues/15 - We could make a similar core issue if folks think that we are ready to put something like this in core.
