Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[UX] Rename instances of "database update(s)" to "system update(s)" #1986

Closed
klonos opened this issue Jun 23, 2016 · 22 comments
Closed

[UX] Rename instances of "database update(s)" to "system update(s)" #1986

klonos opened this issue Jun 23, 2016 · 22 comments

Comments

@klonos
Copy link
Member

klonos commented Jun 23, 2016

We do CMI config file updates too, which are not db updates. Proper would be "Database and config updates", but too verbose. I think "system" encompasses both db and config, so I think that we should go with that unless there are better suggestions.

@klonos
Copy link
Member Author

klonos commented Jun 23, 2016

I can try a PR if we agree on the name.

@klonos
Copy link
Member Author

klonos commented Sep 15, 2022

This was recently brought up by @laryn in Zulip, during the preparation of the 1.22.0 release: https://backdrop.zulipchat.com/#narrow/stream/218635-Backdrop/topic/Release.20Day/near/282444669

Also, is this term "database updates" potentially a misnomer at this point?
e.g. an update hook that only affects CMI

...

I found an update hook here: #336
Which prompted the question above since it's a CMI update (not a database update) but will still trigger the red warning, right?

@indigoxela
Copy link
Member

I'm supporting this! And if it were only that I don't have to 🙄 on every Backdrop update with CMI-only changes.

I'm not sure if I can help much with wording, though. ("System updates" seems a little weird to me.)

@klonos
Copy link
Member Author

klonos commented Sep 15, 2022

Here's an initial PR for this: backdrop/backdrop#4203

I have changed things to "system updates" for now, but happy to change it to anything better we may come up with.

I have left 3 instances of "database update" in cor/modules/system/system.api.php, since these were legitimately referring specifically to database schema updates.

@klonos klonos self-assigned this Sep 15, 2022
@klonos klonos changed the title Rename "Database updates" and "database update script" to "System updates" and "system update script" respectively. Rename instances of "database update(s)" to "system update(s)" Sep 15, 2022
@klonos
Copy link
Member Author

klonos commented Dec 13, 2022

Thanks for having a look @kiamlaluno 🙏🏼 ...any others to chime in? ...any thoughts re using "system updates" for what we should be calling these things? ...any other suggestions?

PS: I've rebased and pushed changes, which triggered the re-creation of the PR sandbox if anyone wants to poke around the UI.

@laryn
Copy link
Contributor

laryn commented Dec 13, 2022

I can't think of anything better than "system updates" at the moment (and "system updates" is better than "database updates").

@argiepiano
Copy link

argiepiano commented Dec 13, 2022

The issue with System Updates is that we already have a page called System Updates that takes care of downloading core and contrib when there are updates. This may create confusion.

Screen Shot 2022-12-13 at 8 05 34 AM

So, after doing "System Updates" (downloaded the updates), we will be prompt to "Run system updates" again?

Screen Shot 2022-12-13 at 8 07 48 AM

The end user could care less if the "Database Updates" are not really "Database Updates" - it's all part of the process. While as a developer I understand the change of language, I don't see how it may be helpful to the site builder.

@laryn
Copy link
Contributor

laryn commented Dec 13, 2022

Good point about that existing page!

I'd still like to try to clarify the name if possible. Would "internal updates" work? Or would "database/config updates" be too bulky?

@olafgrabienski
Copy link

I agree that System updates might be confusing. Even if it is a bit lengthy, I'd prefer something like "Database / config updates", depending on the context, e.g.:

  • Database or configuration update
  • Database and configuration updates

@argiepiano
Copy link

How about something like "Update tasks"? So:

  • "Run update tasks" on my second screenshot above
  • And then use (in this screenshot)
    • "Backdrop update tasks"
    • "Use this utility to update your database and configurations whenever you install a new version of Backdrop CMS or one of the site's modules."

Screen Shot 2022-12-13 at 8 17 51 AM

@indigoxela
Copy link
Member

How about something like "Update tasks"?

Hey, this could just be the solution. 👍 I'd vote for "Update tasks".

@laryn
Copy link
Contributor

laryn commented Dec 13, 2022

I like that too.

@olafgrabienski
Copy link

olafgrabienski commented Dec 13, 2022

Indeed, "Update tasks" sounds good!

Use this utility to update your database and configurations ...

Maybe better "your database and your configuration files"? (IIRC, database updates can also be related to configuration. If that's true, config files would be a more clear differentiation.)

@avpaderno
Copy link
Member

I would rather call them updates, if system updates can create confusion with the existing page.

@bugfolder
Copy link

"Database/config updates" nicely and concisely describes what's happening. True that many admins won't know or care about the distinction, but for some it might even be a bit educational.

@argiepiano
Copy link

"Database/config updates"

I'm fine with that too.

@klonos
Copy link
Member Author

klonos commented Dec 13, 2022

Right, I also think that the following makes sense:

  • "System updates" are the core, module, theme, and layout template updates
  • "Database/config updates" are exactly what their name implies (as self-explanatory a it can get)

@yorkshire-pudding
Copy link
Member

I'm fine with any suggestion here. I have a slight preference for "Database/config updates"

@jenlampton jenlampton changed the title Rename instances of "database update(s)" to "system update(s)" [UX] Rename instances of "database update(s)" to "system update(s)" Sep 14, 2023
@jenlampton
Copy link
Member

jenlampton commented Sep 14, 2023

So, after doing "System Updates" (downloaded the updates), we will be prompt to "Run system updates" again?

I think using the same terminology for these things makes a lot of sense, actually. Using the installer module we install the module (download the code) before we install the module (turn it on and run any datayabse+config changes). Both steps are required to install.

Database/config updates

If we do decide to go with this alternative, I think it needs to be full and complete words, like Database and configuration updates.

"System updates" are the core, module, theme, and layout template updates
"Database/config updates" are exactly what their name implies (as self-explanatory a it can get)

These things are step 1 and step 2 of the same process. Both steps are required to update. If "Database/config updates" won't ever be done without also doing "System updates" why don't we just call them by the same name?

If we're going to label step 2 of "System updates" specifically, It might be better to also re-label step 1, perhaps as follows:

  • "System updates"
    • Code+file updates
    • Database/config updates

I've done a code review and marked this issue RTBC (it currently uses "System updates"), but if we need more time to discuss terminology, we should remove either that or "works for me" so it doesn't get merged :)

@quicksketch
Copy link
Member

I'm moving this back to review as it seems like several people expressed concerns about using the term "System Updates" (which is what backdrop/backdrop#4203 uses).

I think "System Updates" is better than "Database Updates", but the above feedback is valid. I'm leaning towards merging this as-is. If someone else agrees that this is fine as-is; please move this back to RTBC then I'll merge it.

@klonos
Copy link
Member Author

klonos commented Jul 5, 2024

With #5630 landing in 1.28.1, we've now changed "database updates" to "site updates"! 🎉 ...I'll double-check if there's anything useful in the comments above. or in the PR that we need to consider, and will then close this.

@klonos klonos removed their assignment Jul 5, 2024
@klonos
Copy link
Member Author

klonos commented Jul 5, 2024

I've filed #6644 as a follow-up. Closing.

@klonos klonos closed this as completed Jul 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

10 participants