Review main Merged

84527[TASK] Improve info text for backend layouts with no colPos assigned

Georg Ringer CR +2 V +2 Easy +2 −2 updated 06/20/24, 11:27

Commit message

As the editor doesn't know anything about the name "colPos" the text is
changed.

Review

  • Code review CR +2 Done
    • Christian Kuhn +2
    • Jasmina Ließmann +1
    • Garvin Hicking +1
  • Verified V +2 Done
    • Christian Kuhn +2
    • Jasmina Ließmann +1
    • Garvin Hicking +1
    • core-ci +1 CI

Issues 1

Files 1

Review log 1417

  1. Georg Ringer uploaded patch set 1 06/08/24, 07:38

  2. Georg Ringer commented on patch set 1 06/08/24, 07:39

    This change is ready for review.
  3. core-ci voted on patch set 1 V -1 06/08/24, 07:45 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/58908

  4. core-ci voted on patch set 1 V +1 06/13/24, 12:11 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/58908

  5. Garvin Hicking voted on patch set 1 CR +1 V +1 06/13/24, 12:55

  6. Rachel Foucard commented on patch set 1 06/13/24, 13:36

    Hello Georg, "Section" could be a better wording and could put everyone in agreement (developers and editors alike) as it corresponds to a "logical grouping of contents" in HTML5 and is easy to understand/translate. Also, the sentence "This column has no content area ("colPos") assigned. This is only for display purposes." is still describing to much technical details in the page module context and add confusion between "column" and "content area". This could be replaced by "This section is only for display purposes." so I would suggest: "Empty section" "This section is only for display purposes." I've added screenshots in the forge ticket to better visualize de sentences in the usage context.
  7. Garvin Hicking commented on patch set 1 06/13/24, 14:20

    Reply

    IMO for integrators/developers to spot potential misconfiguration it would really help to keep "colPos" as a keyword in the sentence somehow. I agree with the rest of your assessment. How about: "Empty section" "This section is only for display purposes, no 'colPos' configuration is set." ?
  8. Rachel Foucard commented on patch set 1 06/13/24, 14:34

    Reply

    would it be possible to display this dev related information only in the dev context like the fields name in the form (in red and with brackets)?
  9. Garvin Hicking commented on patch set 1 06/13/24, 14:41

    Reply

    The problem is there are enough people "developing" in their production contexts, and this would be information then not revelead to exactly those integrators that might possibly need it. Also it would require some PHP code and complexity for this distinction... I think having it as a part of the sentence wouldn't hurt too much?
  10. Rachel Foucard commented on patch set 1 06/13/24, 15:23

    Reply

    Well, it is only my perception, but I think that each time an editor reads "colpos" and start to wonder what it is (and never find out), it hurts their relation to the product. Also, developing in production context should not be a use case to cover IMHO. But it's true that I don't know if it takes longer to integrate this instead of adapting a sentence, and that I won't be the one who build the solution, so it is only a suggestion of course. If it helps to decide if this context condition is worthwhile: in the long term and a larger scope, conditioning some messages according to the development context could help us keeping things simple for editors without losing crucial information for developers. And it could definitely become a UX / UI best practice.
  11. Rachel Foucard commented on patch set 1 06/14/24, 09:23

    Reply

    please, don't freeze this patch just because of my feedback. Garvin's proposal is good enough for now: "Empty section" "This section is only for display purposes, no 'colPos' configuration is set." And we can have a more general discussion somewhere else about "dev related information in the UI" to find a long term solution and good practice.
  12. Georg Ringer uploaded patch set 2 CR +1 V +1 06/14/24, 09:51

  13. core-ci voted on patch set 2 V +1 06/14/24, 10:00 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/59587

  14. Garvin Hicking commented on patch set 2 CR +1 V +1 06/14/24, 10:36

    Reply

    No no, your feedback is valid and understandable. I agree for the long (mid?) term solution, providing a better editor experience in this case and hide more "DEV" wording. Maybe we could alter the output here not based on Environment context (Development/Production/Staging) but instead only show additional warnings like this to Maintainers / Admins? Very worthful to discuss, but probably not here 😄 I'm resolving this and thanks for agreeing to the current wording change!
  15. Christian Kuhn voted on patch set 2 CR +2 V +2 06/20/24, 11:01

  16. Jasmina Ließmann voted on patch set 2 CR +1 V +1 06/20/24, 11:01

  17. Christian Kuhn merged patch set 3 06/20/24, 11:27