Problem/Motivation

The description of the Media module (as displayed on the Extend page) does not follow the UI text standards. https://www.drupal.org/docs/develop/documenting-your-project/help-text-s...
It should describe what the module does, not what the user can do with it. (That's in the description of the menu link and on the Structure page.)
The description of the Media library has a typo, but can also be improved a bit to use some different wording instead of repeating the word "library" for users who don't have a mental picture what that could mean.

Proposed resolution

Edit the descriptions of the Media and Media library modules.

Remaining tasks

Edit the descriptions of the Media and Media library modules.

User interface changes

This is a UI text change.

API changes

None.

Data model changes

None.

CommentFileSizeAuthor
#4 2985346-media-modules-descriptions-04.patch927 bytesifrik
#2 2985346-media-modules-descriptions-02.patch950 bytesifrik

Comments

ifrik created an issue. See original summary.

ifrik’s picture

ifrik
she/her
commented
Assigned: ifrik » Unassigned
Status: Active » Needs review
StatusFileSize
new 2985346-media-modules-descriptions-02.patch950 bytes

Media module: I've added information about the pre-configured media types, and aligned it with the proposed text for the Node module in #2570985: Update the module descriptions on the Extend page.
Media library: the description of a media reference field uses the word "media list" and refers to "using existing media" so the module description can reflect this wording. Also, users might use a media item for the first time.

marcoscano’s picture

marcoscano
Primary language Portuguese, Brazil
Location Barcelona, Spain
commented
Status: Needs review » Needs work
Issue tags: +Media Initiative

Thanks @ifrik! I agree these texts could be improved.

  1. +++ b/core/modules/media/media.info.yml
@@ -1,5 +1,5 @@
-description: 'Create reusable media.'
+description: 'Provides pre-configured media types and manages the creation, configuration of display of media items.'

    The pre-configured media types are only available in the standard profile, they don't come with the module itself.

    After comparing it with the Node text, how about "Allows media items to be created and reused throughout the site." 

  2. +++ b/core/modules/media_library/media_library.info.yml
@@ -1,6 +1,6 @@
-description: 'Provides a library for re-using Media Items.'
+description: 'Provides a media list so users can easily find and use existing media items.'

    The media module itself already provides a media list, available at /admin/content/media.

    How about "Provides an enhanced media list with additional features."

    (unfortunately that's all the module does right now)

ifrik’s picture

ifrik
she/her
commented
Status: Needs work » Needs review
StatusFileSize
new 2985346-media-modules-descriptions-04.patch927 bytes

Thanks for the review.

The node module description is to be changed once the long standing issue about the module descriptions is finally committed, so I aligned it with that.
Therefore I would go for
Media: Manages the creation, configuration of display of media items.
and
Media library: Enhances the media list with additional features to easier find and use existing media items.

Version: 8.6.x-dev » 8.7.x-dev

Drupal 8.6.0-alpha1 will be released the week of July 16, 2018, which means new developments and disruptive changes should now be targeted against the 8.7.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

seanb’s picture

seanb
Primary language Dutch
Location Netherlands
commented
Status: Needs review » Reviewed & tested by the community

Look good to me.

Status: Reviewed & tested by the community » Needs work

The last submitted patch, 4: 2985346-media-modules-descriptions-04.patch, failed testing. View results

seanb’s picture

seanb
Primary language Dutch
Location Netherlands
commented
Status: Needs work » Needs review

Retest for 8.7 since the media library was (hopefully temporarily) removed from 8.6.

manish-31’s picture

manish-31 commented
Status: Needs review » Reviewed & tested by the community

2985346-media-modules-descriptions-04.patch applies successfully for 8.7.x-dev .

alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
commented
Status: Reviewed & tested by the community » Fixed

Committed and pushed c9159d8633 to 8.7.x and 1a25e7f2fb to 8.6.x. Thanks!

Backported to 8.6.x as a non-disruptive bug fix.

  • alexpott committed c9159d8 on 8.7.x 
    Issue #2985346 by ifrik, marcoscano: Edit Media modules descriptions to...

  • alexpott committed 1a25e7f on 8.6.x 
    Issue #2985346 by ifrik, marcoscano: Edit Media modules descriptions to...

Status: Fixed » Closed (fixed)

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