Problem/Motivation

This is spun off from #2862458: [META] Once media is enabled, having the File, Image and Media reference fields all listed is confusing.

When creating a new field, the site builder is presented with a select list of field types. This select list has been described as "the most problematic select list in all of core" because it's quite opaque. It's not very clear what each field type is for, or what the differences are.

This is a big problem space, but the overall discussion and debate is taking place in the meta issue. One concrete step that has been agreed upon, though, is to expose the field type descriptions to users when they are creating a new field.

Proposed resolution

Field UI should show the field type description below the field type selection box whilst creating a new field.

Remaining tasks

Port the patch from #2862458-91: [META] Once media is enabled, having the File, Image and Media reference fields all listed is confusing, but without any of the verbiage changes. Review and commit that patch.

User interface changes

Field type descriptions will be displayed below the select list when creating a new field.

API changes

None.

Data model changes

None.

Comments

phenaproxima created an issue. See original summary.

phenaproxima’s picture

phenaproxima’s picture

Issue summary: View changes

Minor fix in the IS.

marcoscano’s picture

If this is a standalone patch decoupled from the Media improvements, then maybe we should mark #2930446: [PP-1] Improve field description texts for fields provided by core as duplicate, and improve all descriptions at once here?

benjifisher’s picture

Assigned: Unassigned » benjifisher

I will adapt @marcoscano's patch. I am working with @phenaproxima and others at the Boston Media sprint.

benjifisher’s picture

Assigned: benjifisher » Unassigned
Status: Active » Needs review

I removed the parts of the patch that change the description text, leaving in the parts that display the text in the UI.

I removed the part of the test that checks for the description on a Media field. I left in the parts that test for the description of File and Image fields. These were already independent of the actual text.

benjifisher’s picture

StatusFileSize
new7.24 KB
new2.85 KB

It turns out that thinking really hard about uploading the patch is not actually good enough. Who knew?

phenaproxima’s picture

Status: Needs review » Reviewed & tested by the community

Thanks, @benjifisher! Preemptively RTBC once Drupal CI approves.

berdir’s picture

Similar to #4, I'm still not convinced to show the current, sometimes *very* technical and likely confusing descriptions to end users. It's a bit harder to test them in advance (can be done by applying both patches together for example) , but would IMHO make sense to get the improved descriptions in first or at the same time.

xjm’s picture

Status: Reviewed & tested by the community » Needs review
Issue tags: +Needs manual testing

Yeah I had a similar thought to #9; we don't want to inadvertently create a UX regression for other fields in trying to improve the UX for these. In general, the less text on the screen, the better, so we should make sure this issue doesn't add new text for other fields where it's not needed.

What someone could do is look around core for existing field descriptions that will now be exposed. We can:

  • Post screenshots of what this will look like for File, Image, and Media fields with the current (unpatched) descriptions.
  • Look around core for other existing descriptions that would also now be exposed on this screen for other fields, and document a list of them on the issue. (Probably with a screenshot of the longest or ickiest one.)

Then we can decide what to do for this based on that information.

xjm’s picture

amateescu’s picture

I agree with #9, getting this patch in without improving the descriptions is most likely a UX loss instead of a win.

Also, for committers, all the people who worked on this patch in #2862458: [META] Once media is enabled, having the File, Image and Media reference fields all listed is confusing should be given credit here.

xjm’s picture

Status: Needs review » Postponed
Issue tags: -Needs manual testing

Discussed more with @phenaproxima. We're going to start with adding some brief documentation to media_help() about Media reference fields, how File and Image reference fields are used on them, and what you should use when. Then, we can link to that wherever we need in whatever descriptions we need, potentially display help text as a block rather than as a description, or whatever.

So we'll start with the documentation first, and then decide whether this or another implementation is the correct way to fix it.

Thanks!

benjifisher’s picture

xjm’s picture

Another option is that we could initially display the descriptions only for media, file, and image fields, and only display the other descriptions once they're improved.

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

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

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.

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

Drupal 8.7.0-alpha1 will be released the week of March 11, 2019, which means new developments and disruptive changes should now be targeted against the 8.8.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.8.x-dev » 8.9.x-dev

Drupal 8.8.0-alpha1 will be released the week of October 14th, 2019, which means new developments and disruptive changes should now be targeted against the 8.9.x-dev branch. (Any changes to 8.9.x will also be committed to 9.0.x in preparation for Drupal 9’s release, but some changes like significant feature additions will be deferred to 9.1.x.). For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 8.9.x-dev » 9.1.x-dev

Drupal 8.9.0-beta1 was released on March 20, 2020. 8.9.x is the final, long-term support (LTS) minor release of Drupal 8, which means new developments and disruptive changes should now be targeted against the 9.1.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

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

Drupal 9.1.0-alpha1 will be released the week of October 19, 2020, which means new developments and disruptive changes should now be targeted for the 9.2.x-dev branch. For more information see the Drupal 9 minor version schedule and the Allowed changes during the Drupal 9 release cycle.

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.

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.

dieterholvoet’s picture

martijn de wit’s picture

Status: Postponed » Closed (outdated)
xjm’s picture

Status: Closed (outdated) » Closed (duplicate)

Duplicate is probably a better classification.

Saving credits for those who worked on this one.