Contrib.social

Improve messaging to users to backup database

Open on Drupal.org →
Created on 9 June 2022, over 2 years ago
Updated 14 February 2023, almost 2 years ago

Problem/Motivation

Move forward with feedback received from @rkoller, please find original comment below:

"I have applied the latest patch and have taken a look at the micro copy in the context of admin/reports/updates/automatic-update and admin/automatic-update-ready/. I like and agree that you have added texts on both pages" I would have a few additional points and thoughts to add.

1. I am not sure if starting off by providing a gently and friendly reminder saying, it is a good idea to back up your database, and then in the next step state in bold letters, that it is strongly recommended to back up the database and site, isn't a bit of mixed messaging. I would rather go with an explicit and clear statement on the automatic-update page that it is highly recommended to back up the database and site and then phrase the ready to update text more as the friendly reminder by stating that the downloaded assets will be applied next and that this step cannot be undone, the reason why an update is a good idea. Just provide clear and actionable steps what is recommended in the first place. Currently it sounds more like an update might be a good idea but isn't necessary and then you read on the ready to update page it is recommended after all. So a more explicit variant for the automatic-update page could be:
It is strongly recommended to back up your database and site before you begin.
(*maybe that sentence in bold on the automatic-update page?)

2. On the automatic-update page you have "back up your database" on the ready to update page you have "back up your database and site". It is advisable to be consistent with the actionable recommendation imho. Currently if someone is following the recommendation on the first page and just backs up the database could be puzzled when retrying and then reading on the ready to update page that database AND site should be updated now. Might be even considered annoying for some people. I would suggest to go with the link text "backup your database and site" on both pages.

3. One question that is probably still valid from #4. If an update is triggered manually there is the recommendation to back up the database and site while when the update is triggered and run automatically via cron there is no recommendation. Manually you get the strong recommendation to back up in the micro copy while when run automatically there is no notification for that? That "might" cause also uncertainty once someone triggers a manual update?

4. On the ready to update page you have the first line "Drupal core will be updated to 9.3.15" in a regular weight while the next line is bold. The sole focus is on the bold typeface (at least for me the "Drupal core will be updated part..." was more or less "invisible" or at least unnoticed that way) . I would perhaps make the whole block in a regular typeface and phrase the back up your database part a little bit different. Not that strongly but explaining the reasoning a little bit. I've added the word step to "this cannot be undone. At the end i would provide a brief note about what happens when you hit the cancel update button, stating that the downloaded assets get removed (aka they have to be re-downloaded if the user triggers the update process again):

Drupal core will be updated to 9.3.15. This step cannot be undone. The reason why to back up your database and site before the update was recommended in the first place. If you cancel the update process the downloaded assets get removed.

5. I could offer to put the issue on fridays ux meeting agenda (there is no entry yet - https://www.drupal.org/project/drupal/issues/3284204 → ). There would be a few more pair of eyes to take a look at the issue and the word smithing part in particular. But i don't know how time sensitive the issue is since it is a stable blocker. But i think it would be a good choice.
And if i remember correctly Aaron also suggested a few weeks back in one automatic update issue to bring the automatic updates module in general to one of the UX meetings so that we could take a look as a group."

📌 Task
Status

Needs review

Version

3.0

Component

Code

Created by

🇺🇸United States Theresa.Grannum Boston

Live updates comments and jobs are added and updated live.
  • Usability

    Makes Drupal easier to use. Preferred over UX, D7UX, etc.

Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • Comment almost 2 years ago →
    🇺🇸United States tedbow Ithaca, NY, USA
  • Comment 5 days ago →
    🇮🇳India rajeevkumar

    1. Clarify and Strengthen the Backup Recommendation:
    Solution: Make the backup recommendation clearer and more consistent across both pages.

    • Automatic Update Page: Start with a clear and firm recommendation. For example, update the text to:
    • "It is strongly recommended to back up your database and site before beginning the update process." (Consider making this bold for emphasis.)
    • Ready to Update Page: Phrase this as a friendly reminder, mentioning that the update is imminent. Example:
    • "The downloaded assets will be applied to your site in the next step. This action cannot be undone. Please ensure you have backed up your database and site before proceeding."

    2. Ensure Consistent Language:
    Solution: Standardize the language between the two pages. Both should use "back up your database and site" rather than varying the recommendation.

    • Automatic Update Page: Update the text to say "back up your database and site" for consistency.
    • Ready to Update Page: Likewise, update this page to consistently recommend backing up both the database and site.

    3. Ensure Backup Recommendation for Both Manual and Automatic Updates:
    Solution: Add a backup recommendation for automatically triggered updates (via cron).

    • Automatic Update Process (via cron): Add a reminder to back up your database and site before automatic updates are triggered. This can be phrased as a part of the notification when the update is initiated automatically:
    • "Before proceeding with the automatic update, ensure you have backed up your database and site."

    4. Improve Text Layout for Better Readability:
    Solution: Adjust the typography to improve the visual hierarchy and readability.

    • Ready to Update Page: Make the first sentence ("Drupal core will be updated...") stand out by using regular typeface rather than the bold type. The important part about the backup recommendation should be integrated smoothly into the text, without overemphasizing one part.
    • For example, revise the entire block like this:
    • "Drupal core will be updated to 9.3.15. This step cannot be undone. It is strongly recommended that you back up your database and site before proceeding. If you cancel the update process, the downloaded assets will be removed and need to be re-downloaded."
contrib.social Blog FAQ Discussions
Production build 0.71.5 2024