Problem/Motivation

The Media Library module's handbook docs have some TODOs to link to other parts of the online drupal.org documentation.

Additionally, the docs could probably stand to be structured a bit more optimally (for example, not combining content author-facing docs and site builder-facing docs on the same page).

Proposed resolution

Here are a few outstanding places the docs under https://www.drupal.org/docs/8/core/modules/media-library-module, which are already amazing, could be improved:

Remaining tasks

Do those things.

User interface changes

Not much.

API changes

N/A

Data model changes

N/A

Release notes snippet

N/A

CommentFileSizeAuthor
#3 media_add.png97.25 KBfkelly12054@gmail.com

Comments

phenaproxima created an issue. See original summary.

webchick’s picture

Title: Link Media Library documentation to helpful resources » Perform further Media Library documentation polishing
Project: Drupal core » Documentation
Version: 8.8.x-dev »
Component: media system » Correction/Clarification
Issue summary: View changes
Issue tags: +D8Media

Refining this issue some.

fkelly12054@gmail.com’s picture

StatusFileSize
new97.25 KB

Trying the new Media Library on a local test system after 8.8.0 released.

Go to content/add media and select a few image files. You get a screen like the one I uploaded with (for example) three files listed. The first one becomes the media item and all three are added as files. If you later go to ckeditor wysiwyg add media item only the first file shows as an option to add. However, once you've added it, all three files show when you are in the full content view mode.

I'm not good with Drupal speak, but from reading it seems like the first item is a media entity and all three are part of that entity and linked to it by having a common MID and the same UUID. ??? It would be helpful if the documentation explained that.

It also appears that if you wanted each file to be its own media entity you'd have to add them one screen at a time. Again, helpful if this was explained in the documentation (and if the user interface made it clearer what was happening.

Maybe the documentation could start by having a section on "what's a media entity" and how it works vis a vis files.

Especially with all the outstanding issues relating to deleting files: e.g.,
https://www.drupal.org/forum/support/post-installation/2019-02-07/delete...

I don't think you really want to make it easy for users to add files that they later find they want to delete and can't.

I'll be happy to test if any documentation you develop is suitable for dummies.

alison’s picture

Issue summary: View changes

Hi! I arrived here from the "Discuss" thread on the "Overview" doc page.

We should add something about "Media settings > enable advanced UI" -- I didn't understand the help text on this checkbox, to be honest, but that might just be me. I mean, I also think it's a weird setting -- not sure the benefit of leaving this option disabled -- but again, might just be me. The help text and the value of the setting are irrelevant here *except* that further explanation could be helpful for writing a couple sentences to add to the Overview doc page re: this setting.

-------
Anyway!

Should probably start by updating the section near the end where it says "When you have finished entering required information, you have two choices:" -- because, if I'm understanding correctly, that isn't true unless "Enable advanced UI" is enabled -- right, or?

(Caveat: I'm not sure what happens if you've selected media items, then uploaded something new, but "enable advanced UI" is disabled -- I imagine you just get the "Save" button you'd get if you didn't select media items before adding a new thing, and then you're kicked back to the library with your new item selected, along with the previously selected things, but I'm not sure.)

Perhaps... (My suggested changes start right after "If you had previously chosen items from the media library before you started adding new items, those selections will be remembered; you can see them in the "Additional selected media" area.")

<p>When you have finished entering required information, click "Save" -- the new media item(s) will be saved to the library, and you'll be returned to the selection screen, where you can insert the new item(s) or select additional items to insert.</p>

<p><strong>Advanced UI</strong></p>

<p>If you enable advanced UI for the media library (Configuration > Media Library settings), the workflow for adding new media to the library will be slightly different.</p>

<p>When you add the new item(s), after you have finished entering required information, you have two choices (instead of the aforementioned "Save" button):</p>
<ul>
	<li><strong>Save and select</strong>&nbsp;will save the new media item(s) into the library, then return&nbsp;to it so you can&nbsp;select more items.</li>
	<li><strong>Save and insert</strong>&nbsp;will&nbsp;save your new media item(s) and insert them, along with any prior selections, directly into the field or text editor from which you opened the media library.</li>
</ul>

(I didn't change anything in the "two choices" bullets.)

-------
Thoughts? Anywhere close to appropriate and accurate, or?

(Also, may or may not need additional or modified screenshots...)

alison’s picture

Issue summary: View changes