Problem/Motivation

On #2888657: [meta] Less confusing and more consistent wording needed in module/theme add/install/update we are trying to make the UI around actions with modules/themes more consistent.

On #2891294: [Meta] Use Install/Uninstall consistently for turning modules/themes on/off (not Enable) we are making sure that when we talk about turning a module/theme on/off, we always use the verbs "Install" and "Uninstall", and on #2577407: Action of uploading module/theme files should consistently be called "Add", not "Install" we are making sure we use the verb "Add" for the action of uploading files for a module/theme.

On this issue, we want to make sure we don't use the verbs Install/Uninstall for other things, such as updating.

Proposed resolution

Make sure we don't use the verbs "Install/Uninstall" in conjunction with modules/themes for anything except turning them on/off. In particular, for updating we should use the verb "Update" not "Install updates".

Remaining tasks

Fix UI text.

User interface changes

More consistent use of the verbs "Install/Uninstall" in conjunction with modules/themes.

API changes

None.

Data model changes

None.

Release notes snippet

Probably not needed for this issue.

Comments

jhodgdon created an issue. See original summary.

jhodgdon’s picture

Issue summary: View changes
Status: Postponed » Active

The patch for #2577407: Action of uploading module/theme files should consistently be called "Add", not "Install" was committed. I spent the time to look for "install" in UI text throughout the core directory of the latest Drupal 9.2.x. I found a bunch of strings that look like they should be addressed in this issue, and added them to the issue summary.

jhodgdon’s picture

Issue summary: View changes
Status: Active » Needs review
StatusFileSize
new13.2 KB

Here's a patch for the items I found that I think need to be done. The last item in the list I had thought we needed to do contained two lines that were actually talking about whether the module was installed (in the sense of turned on), so I didn't patch them. I also looked through all of the strings with "install" in them on localize.drupal.org for Drupal 9.1 to find additional spots that needed attention. Here's a patch.

Removing the list of items to do from the summary, as it doesn't match what I found this time around (there are more items in the patch).

dww’s picture

Looks like a great start, thanks! A few initial concerns looking at the patch:

  1. +++ b/core/modules/system/src/Controller/DbUpdateController.php
    @@ -212,17 +212,17 @@ protected function info(Request $request) {
    -    $info[] = $this->t("<strong>Back up your code</strong>. Hint: when backing up module code, do not leave that backup in the 'modules' or 'sites/*/modules' directories as this may confuse Drupal's auto-discovery mechanism.");
    +    $info[] = $this->t("<strong>Back up your files</strong>. Hint: do not leave a backup of software files under the 'modules', 'sites/*/modules', 'themes', 'sites/*/themes', or 'profiles' directories as this may confuse Drupal's auto-discovery mechanism.");
    

    A) Seems out of scope from the rest of these changes.

    B) Not sure I agree that "files" is better than "code" here. In the UI and Drupal generally, we tend to use "files" to refer to the uploaded files (e.g. sites/default/files) dir.

    C) Does 9.2.x even look at sites/*/modules anymore?

  2. +++ b/core/modules/system/src/Controller/DbUpdateController.php
    @@ -212,17 +212,17 @@ protected function info(Request $request) {
    +    $info[] = $this->t('Update the files for Drupal core, your install profile, modules, and/or themes (as described in the above-linked handbook).');
    

    A) Do we really want to spell out "core, your install profile, modules, and/or themes"? Is "install profile" confusing in this context? ;)

    B) "above-linked handbook" seems a little awkward. How about:

    "... (as described in the handbook page linked above)."?

  3. +++ b/core/modules/update/update.install
    @@ -128,7 +128,7 @@ function _update_requirement_check($project, $type) {
    -        $requirement['description'][] = ['#prefix' => ' ', '#markup' => t('See the <a href=":available_updates">available updates</a> page for more information and to install your missing updates.', [':available_updates' => Url::fromRoute('update.report_update')->toString()])];
    +        $requirement['description'][] = ['#prefix' => ' ', '#markup' => t('See the <a href=":available_updates">available updates</a> page for more information and to update your software.', [':available_updates' => Url::fromRoute('update.report_update')->toString()])];
    

    Ahh, so much better. Thanks! 👍

Meanwhile I grepped the code for 'install' and lo, it's nearly 10K lines. ;) So, yeah, I'm not going to try to go through that to see if we missed anything. I'd be in favor of wrapping this up and getting it in, moving through the rest of the current plan, and if/when we find any other spots we missed, to deal with them in separate follow-ups. Let's not let perfect be the enemy of good.

Thanks!
-Derek

jhodgdon’s picture

StatusFileSize
new2.05 KB
new12.73 KB

Thanks for the review! I actually *did* go through both the *entire* grep -i -R for "install" as well as all of the localize.drupal.org strings. I am sure I missed a few though, since ... well going through everything took a while and my eyes definitely glazed over.

Regarding point 1, I removed that hunk. You are right it is out of scope. But yes, sites/*/modules is (as far as I know) still supported. It was at least in 8.x, not sure about 9.x actually. Anyway, that hunk is not in the patch any more. :)

Regarding point 2, I updated the wording (see interdiff). As a note, we really don't want to refer to the online documentation as the "handbook" at all, but changing that would be out of scope for this issue, so I left it in (and the link referred to as being "above" already says "handbook", so I don't want to change that either).

Version: 9.2.x-dev » 9.3.x-dev

Drupal 9.2.0-alpha1 will be released the week of May 3, 2021, which means new developments and disruptive changes should now be targeted for the 9.3.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.3.x-dev » 9.4.x-dev

Drupal 9.3.0-rc1 was released on November 26, 2021, which means new developments and disruptive changes should now be targeted for the 9.4.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.4.x-dev » 9.5.x-dev

Drupal 9.4.0-alpha1 was released on May 6, 2022, which means new developments and disruptive changes should now be targeted for the 9.5.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

smustgrave’s picture

Issue tags: +Bug Smash Initiative
StatusFileSize
new2.2 KB
new12.78 KB

Took a look at #5 and all makes sense to me

Rerolled for 9.5.x

Version: 9.5.x-dev » 10.1.x-dev

Drupal 9.5.0-beta2 and Drupal 10.0.0-beta2 were released on September 29, 2022, which means new developments and disruptive changes should now be targeted for the 10.1.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

needs-review-queue-bot’s picture

Status: Needs review » Needs work
StatusFileSize
new143 bytes

The Needs Review Queue Bot tested this issue. It either no longer applies to Drupal core, or fails the Drupal core commit checks. Therefore, this issue status is now "Needs work".

Apart from a re-roll or rebase, this issue may need more work to address feedback in the issue or MR comments. To progress an issue, incorporate this feedback as part of the process of updating the issue. This helps other contributors to know what is outstanding.

Consult the Drupal Contributor Guide to find step-by-step guides for working with issues.

ranjith_kumar_k_u’s picture

StatusFileSize
new12.21 KB

Re-rolled #9

ranjith_kumar_k_u’s picture

Status: Needs work » Needs review
smustgrave’s picture

Just FYI to help get the message out there.

Starting March 2023, simple rerolls, rebases, or merges will no longer receive issue credit. Only rerolls that address a merge conflict will be credited, and the merge conflict that was resolved must be documented in the text of an issue comment.
To receive credit for contributing to this issue, assist with other outstanding tasks or unaddressed feedback.
See the issue credit guidelines for more information.

So would need to post how the patch no longer applies to 10.1

smustgrave’s picture

Status: Needs review » Reviewed & tested by the community
Issue tags: +Needs Review Queue Initiative
StatusFileSize
new589.63 KB

Did a search on phpstorm for "install modules" and the results

install

Which seem to refer to actually installing a module. Think this is good (though hard to fully serach)

larowlan’s picture

Updating issue credits

  • larowlan committed 17f21792 on 10.1.x
    Issue #3182405 by jhodgdon, smustgrave, ranjith_kumar_k_u, dww: Do not...
larowlan’s picture

Status: Reviewed & tested by the community » Fixed
Issue tags: +String change in 10.1.0

Committed to 10.1.x, not backporting because of the string changes

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.