Problem/Motivation

The media type descriptions are 1) not consistent with each other and 2) are not consistent with the 'Article' and 'Basic page' descriptions

Proposed resolution

One of the options below:

https://www.drupal.org/files/issues/2021-07-07/media-type-descriptions.png
Proposed Media Type Descriptions

Current

  • Audio: A locally hosted audio file.
  • Document: An uploaded file or document, such as a PDF.
  • Image: Use local images for reusable media.
  • Remote video: A remotely hosted video from Youtube or Vimeo.
  • Video: A locally hosted video file.



We have considered several options (4) and have chosen to use the following one:

Proposed 4

  • Audio: A locally hosted audio file.
  • Document: A locally hosted document, such as a PDF file.
  • Image: A locally hosted image file.
  • Remote video: A video hosted on an external site (for example, YouTube or Vimeo).
  • Video: A locally hosted video file.

Option 4 of the proposed changes is chosen in the latest merge request.

Issue fork drupal-3222668

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

Comments

Chris Matthews created an issue. See original summary.

chris matthews’s picture

Issue summary: View changes
chris matthews’s picture

Title: Make media type descriptions more consisent » Make media type descriptions more consistent

Re-titling, 'cause I can't type.

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.

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.

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

Drupal core is moving towards using a “main” branch. As an interim step, a new 11.x branch has been opened, as Drupal.org infrastructure cannot currently fully support a branch named main. New developments and disruptive changes should now be targeted for the 11.x branch, which currently accepts only minor-version allowed changes. For more information, see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

anweshasinha’s picture

StatusFileSize
new2.81 KB

Hi,
I have changed the media type description and added in patch. Please review the changes.

shivam-kumar made their first commit to this issue’s fork.

shivam-kumar’s picture

Created a MR !6313 for the above patch.

shivam-kumar’s picture

Status: Active » Needs review

Moved to needs review.

smustgrave’s picture

Status: Needs review » Needs work
Issue tags: +Novice

Should also be done in other spots used. Umami has media types also.

bharath-kondeti made their first commit to this issue’s fork.

shweta__sharma’s picture

Status: Needs work » Needs review
shweta__sharma’s picture

Tested MR 6313 changes are updated as per the proposed solution. Proposed#3 has been applied.
Thanks

kanchan bhogade’s picture

Assigned: Unassigned » kanchan bhogade
kanchan bhogade’s picture

Assigned: kanchan bhogade » Unassigned
Status: Needs review » Needs work
StatusFileSize
new83.19 KB
new85.92 KB
new79.9 KB
new80.24 KB

Hi,
I have verified and tested MR !6313 on Drupal version 11.x for Standard and Umami

Testing steps:

  1. Install Drupal 11.x
  2. added Media and Media Library modules
  3. Check for Media type descriptions
  4. Apply the patch and check again for the same

Test Result:
The media type description has been updated, but the Media name should be Italic and
Image Description should - "Use Image for locally hosted image files ( use "for" not "or")

Attaching screenshots for reference.

smustgrave’s picture

@bharath_kondeti this was tagged for novice just yesterday, which is intended for newer users. Based on your post history believe you should avoid novice issues in the future please

kazuko.murata’s picture

Status: Needs work » Needs review

I came across this issue during the Drupal Contribution Day Japan 2025.
https://www.drupal.org/community/events/drupal-japan-contribution-day-ju...

It looks like both the Standard and Umami profiles' config have already been updated.

If there's anything left to be done, I'd be happy to work on it.

dcam’s picture

Tagging for subsystem maintainer review to weigh in on which proposed description format we want to use.

If option 3 is chosen, then this needs to go back to Needs Work status to italicize the type name as noted in #18.

And in my opinion the issue summary needs to be updated because the text included in that image is not accessible. Someone should rewrite it into plain text in the summary.

jensdn’s picture

Issue summary: View changes
Issue tags: -Needs issue summary update

Updated summary and remaining tasks

jensdn’s picture

Issue summary: View changes
jensdn’s picture

Issue summary: View changes
vijaycs85’s picture

Status: Needs review » Needs work
vijaycs85’s picture

Issue tags: +Vienna2025

pguillard made their first commit to this issue’s fork.

pguillard’s picture

Status: Needs work » Needs review

Changed to single quotes

xjm’s picture

Status: Needs review » Needs work
Issue tags: -Needs subsystem maintainer review +Nara2025, +Needs issue summary update

I'm not sure where "proposed 3" came from, but it's not grammatically correct without the italics (e.g. "Use image for locally hosted image files" is missing an article).

Also, fewer words is better. So, if we're repeating "Use foo for [what foo is] every time when the context already makes it clear that we're talking about a foo, that's not helpful. Therefore, I'd propose we instead use the format like (e.g.):
"A locally hosted image file."
And standardize on the singular.

This will need the issue summary updated to reflect that new approach, and an updated MR. Thanks!

The Drupal Contribution Mentoring team is triaging issues for DrupalCon Nara 2025, and we are reserving this issue for Mentored Contribution during the event.

After November 19, this issue returns to being open to all. Thanks!

sourav_paul’s picture

I agree with #29, as it sounds good & correct in context.
I’d like to contribute this issue — working on refining the description text patch as proposed.

sourav_paul’s picture

Here is patch with proposed changes
It would be helpful, if anyone could review.

xjm’s picture

@sourav_paul, are you contributing at DrupalCon Nara? If so, welcome, and come find one of the mentors tomorrow for help creating a proper merge request!

If not, please follow the green message in #29 until after November 19. Thanks!

hktang’s picture

Hi all, I am at DrupalCon Nara 2025 and am working with my team to create a merge request.

h_bee’s picture

I am contributing on this issue with a team at Nara DrupalCon 2025

suryanto’s picture

Issue summary: View changes

We added a new approach as proposed 4 in the issue summary based on #29

hktang’s picture

Status: Needs work » Needs review

Our team (@silverham, @h_bee, @suryanto, @rduterte, @akmalfikri and myself) proposed the above changes for review.

  1. We reviewed the issue history and agreed to implement the proposal by @xjm (#29), mainly to use concise and consistent language.
  2. We updated the issue summary by added Option 4, based on the discussion history on this thread.
  3. We reversed the changes instead of force-pushing our changes, based on advice by @silverham.
  4. We have confirm the CI checks passed, and updated the issue status to "Needs Review".
akmalfikri’s picture

I am contributing on this issue with a team at Nara DrupalCon 2025

h_bee’s picture

Issue summary: View changes
h_bee’s picture

After the changes were put into a merge request, we reviewed the merge request. I added some small remarks about the quote format to be used, so it can become more consistent. I also updated the issue description for the next steps to be taken.

h_bee’s picture

Status: Needs review » Needs work
mradcliffe’s picture

Status: Needs work » Needs review

This is amazing work, everyone.

Can we update the issue summary to mention which of the propose resolutions is the one in the merge request?

And then I think based on the discussion at the table in Nara, we decided to link the related issue about standardizing the quote formats, and then we can remove that as an action item and resolve the merge request threads.

Then remove the Needs issue summary update and I think we can change the status to RTBC!

h_bee’s picture

h_bee’s picture

Status: Needs review » Reviewed & tested by the community
h_bee’s picture

xjm’s picture

Status: Reviewed & tested by the community » Needs review

Thanks for the great work on this everyone! I think we've come up with the best solution.

Now that we've settled on a proposed resolution, we can simplify the proposed resolution section to just say that several different proposals were considered, and to document the one we chose.

I agree with @rduterte's assessment that the issue of inconsistency between single and double quotes already has its own issue, and is therefore best not managed here. Good scope management! (There are legitimate cases for double quotes when strings contain apostrophes, for example, etc. etc.... and all that discussion would derail this issue, which is why we move the discussion outside this scope.)

I've made two very tiny suggestions on the merge request. If the contributors think these are good changes, then you can review them and mark the issue back to "Reviewed and tested by the community".

h_bee’s picture

Issue summary: View changes

The issue summary has been changed and it has been reviewed again. The change(s) suggested by @xjm is/are integrated.

h_bee’s picture

Status: Needs review » Reviewed & tested by the community
h_bee’s picture

Issue summary: View changes
h_bee’s picture

Issue summary: View changes
silverham’s picture

(comment as helped with cherry pick of git code at DrupalCon Nara 2025)

  • xjm committed 4888d905 on 11.x
    task: #3222668 Make media type descriptions more consistent
    
    By: @...

  • xjm committed dc3e7f9a on 11.3.x
    task: #3222668 Make media type descriptions more consistent
    
    By: @...
xjm’s picture

Status: Reviewed & tested by the community » Fixed

Committed LIVE at DrupalCon Nara! Thanks to everyone who helped contribute to this issue over the past for years.

Cherry-picked to 11.3.x as a minor-safe string change.

Thanks!

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.

sourav_paul’s picture

Awesome team!
Nice to see that, it got resolved.

Status: Fixed » Closed (fixed)

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