Better wording of the module life-cycle admin pages

Created on 28 July 2020, almost 5 years ago
Updated 28 May 2025, 8 days ago

Problem/Motivation

Drupal's Module Life-cycle (installation) requires some thinking around the wording of the user interfaces. This effort is mostly text and URL change suggestions. This is surfacing because there are so many issues for over a decade that attempt to harmonize the words used to describe the different parts of installation, as consolidated in this issue. I hope we can close all these issues after some discussion, whether text will be changed or not. I've consolidated all suggestions on all the relevant issue pages for everyone to revise.

Steps to reproduce

Not relevant. See current pages in Proposed Resolution.

Proposed resolution

The first section is for commentary and discussion. The second section is just for the final wording on each admin page.

Commentary and Discussion Section

This section contains all commentary for discussion. Add your commentary here or in comments.
The next section (labeled User Interface) has no commentary, just User Interface suggested text changes, including link names.

A) These changes can be partitioned into three,
1) Immediate changes, things that can be done within weeks
2) Short term changes, things that can be done within quarters
3) Long term changes, things that can be done by Drupal 10 or 11

B) The phrase 'Module (Installation) Life-cycle' as used here includes
(to edit, see spreadsheet in post #3 below)
1) Adding a module,
2) then Enabling it,
3) then Permissioning it,
4) then Configuring it,
5) then Updating it,
6) (consolidate by Drupal 10? ... then Disabling it, then Uninstalling it)
7) then Deleting it (database and files).
These last three (disable, uninstall, delete) need a road-map, which we'll create today with this discussion. For new and most Druplers, Add and Delete should be enough for most of the time. For the heavy developers and testers Enable/Disable (or Activate/Deactivate) is nice to have so perhaps we can set it aside for them, or a link to help document.

Deciding on this wording will make it easier to change the remaining sentences, buttons, and links. So let's start with wording.

Above, I skipped the word Install because it has three steps, for security, ... Add then Enable then Permission (and really Configure). Only after all four are done is it really installed in the way we think of all other installations of non Drupal software. So I suggest not using Install as a single word or step but rather as an Installation Process or Drupal Module Life-cycle.

Today in Drupal, we Add Content, Add Taxonomy, Add Menu, Add View, and so on. So let's Add Module. Then we also Delete Content, Delete Taxonomy, Delete Menu, Delete View, and so on. So let's Delete Module, regardless of the complications unseen by the user. Even our /admin/modules/uninstall/confirm page uses the word Delete twice. WordPress uses Add Plugin and Delete Plugin. WP also uses Activate/Deactivate in between.

Benji brings up a good question πŸ“Œ Drupal Usability Meeting 2020-07-28 Fixed about Disable which gets answered by walking through the steps. After Adding a module, it's not enabled, for security. So what do we call that in documentation? We could use the phrase "not Enabled" or "Disabled" or "Deactivated". We definitely can't call it Uninstalled, so that word is out. The word Uninstall is out because it's antonym Install is a process which we won't use. So that's why the Install/Uninstall pair can't be used for the steps. They can be used for the process, Installation Process or Uninstall Process, since both processes are multi-step.

C) The second most important thing to do is create an Installation Process wizard or steps page or document, because today new users have to hunt around on how to upgrade. Take for example upgrading Drupal, the update page (/admin/modules/update) doesn't offer how to download core, how to manually overwrite, and that update.php MUST be run afterward. (I can't even find a document for new users.)

D) Suggest removing or modifying the semi duplicate web page /admin/reports/updates
1) This has no function yet it looks the same as /admin/modules/update. It's misleading that one can't actually update from that page and there are no instructions on where to go to update, especially for the brand new or occasional Drupaler.

2) It duplicates URLs because the Update tab goes to the update page with another URL (/admin/reports/updates/update) not that page's real URL (/admin/modules/update).

3) It's breadcrumbs are different making new users think they do different things.

4) The setting and uninstall tabs are missing from one and the other.

Proposed Module Life-cycle User Interface Section (no commentary nor discussion)

This User Interface section should only contain the complete User Interface as it should finally become after discussions. No commentary nor discussion. Below are changes to each page in the entire module life-cycle where we can improve the wording.

Extend

Extend your site's functionality by adding contributed modules β†’ . The button below will walk you though the steps to add a module or theme.

+ Add module (button)

For your convenience, you can limit the list below by entering a part of the module name or description
(Filter by name or description box)

Below you can view information about your already installed modules and themes. For security, newly added modules and some Drupal core modules are disabled (unchecked) by default. You can enable β†’ them by checking them then press the Save button.

(list of modules)

Save (button)

** /admin/modules/add (was /admin/modules/install)

Four steps to installing a module, 1) add it, 2) enable it, 3) configure it, then 4) permission it. This is step one.

Add module or theme from a URL

Or

Add module or theme by uploading the archive

Save button

Update changed modules (/admin/modules/updatesavailable) regularly to maintain a secure and current site.

Important!
1. Before you begin, read more detailed information in the upgrading handbook.
https://www.drupal.org/upgrade β†’
https://www.drupal.org/docs/user_guide/en/understanding-modules.html β†’
2. Back up your database and site before you continue. Learn how. https://www.drupal.org/node/22281 β†’
3. Run the update script (/update.php) after each Drupal Core, module, or theme update.

Last checked: 9 minutes 33 seconds ago (Check manually)
(List of modules to update)

Manual updates required
Automatic updates of Drupal core are not supported at this time. Manual update instructions.

(Put here the entire "Drupal Core" section (View block?) from /admin/reports/updates)

Download Drupal Core button

Update manager
Four steps to installing a new module, 1) add it, 2) enable it, 3) configure it, then 4) permission it. This is step two.

Status message
Module added successfully.
colorbox
Added colorbox successfully
Next steps
You must manually enable newly added modules, here. (Step 3)
Add another module
Administration pages

Update manager
Status message
Operating in maintenance mode. Go online.
Update was completed successfully.
views
Updated views successfully
ctools
Updated ctools successfully
Next steps
Your modules have been downloaded and updated.
Run database updates

+ Add module or theme

This button above will walk you though the steps to add a module or theme.

Below you can view and find information about available updates for your already installed modules and themes. Note that each module or theme is part of a "project", which may or may not have the same name, and might include multiple modules or themes within it.

If there are updates go to /admin/modules/updatesavailable regularly to update so you have a secure and current site.

Check for updates
Daily
Weekly
Select how frequently you want to automatically check for new releases of your currently installed modules and themes.
Check for updates of uninstalled modules and themes
Email addresses to notify when updates are available

Whenever your site checks for available updates and finds new releases, it can notify a list of users via email. Put each address on a separate line. If blank, no emails will be sent.
Email notification threshold
All newer versions
Only security updates
You can choose to send email only if a security update is available, or to be notified about all newer versions. If there are updates available of Drupal core or any of your installed modules and themes, your site will always print a message on the status report page, and will also display an error message on administration pages if there is a security update.

Deleting a module, permanently deletes all it's data. It does not delete the files, which you can do manually β†’ .

For your convenience, you can limit the list below by entering a part of the module name or description
(Filter by name or description box)

Check the modules you want deleted then press the Delete button.

The following modules data will be deleted from your site! You can manually delete β†’ the module files.

MODULE to DELETE
The listed module(s) will be deleted.

Are you sure you want to delete all data and the module?

Delete Cancel (buttons)

Remaining tasks

1) Review, revise then conclude on suggestions above.
2) Implement changes that can be made immediately or in the short term.
3) Plan out the more involved or time consuming changes.
4) Get those changed.
5) Close all relevant issues.

User interface changes

Wording and link changes to the entire Module Life-cycle to make it less confusing for new or occasional Drupal administrator.

API changes

None.

Data model changes

None.

Release notes snippet

TBD

🌱 Plan
Status

Active

Version

11.0 πŸ”₯

Component

user interface text

Created by

πŸ‡ΊπŸ‡ΈUnited States sajosh

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

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

  • String freeze

    It affects the translatable strings and it should be committed before the string freeze milestone of the release cycle.

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.

  • πŸ‡³πŸ‡ΏNew Zealand quietone

    The Ideas project is being deprecated. This issue is moved to the Drupal project. Check that the selected component is correct. Also, add the relevant tags, especially any 'needs manager review' tags.

  • πŸ‡³πŸ‡ΏNew Zealand quietone

    This is actually a meta.

Production build 0.71.5 2024