Review main Merged

81888[TASK] Revise wording in TCA ext_tables.php check

Torben Hansen CR +2 V +2 Easy +5 −16 updated 11/23/23, 15:12

Commit message

The TCA ext_tables.php check in install tool refers to a conceptual
change in TYPO3 6.2 and explains, why TCA overrides should be used
in favor to TCA modifications in `ext_tables.php`.

This change removes the explanation about the conceptual change in
TYPO3 6.2 and adds a brief overview of required changes. Additionally,
all file- and folder-names are now surrounded with the HTML code
tag to add proper visual code highlighting.

Review

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

Issues 1

Files 2

Review log 1216

  1. Torben Hansen uploaded patch set 1 11/23/23, 10:15

  2. core-ci voted on patch set 1 V +1 11/23/23, 10:23 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/49629

  3. Stefan Bürk updated the commit message in patch set 2 V +1 11/23/23, 10:52

  4. Garvin Hicking commented on patch set 2 11/23/23, 10:58

    Good idea, some thoughts on wording+links :-)

    TcaExtTablesCheck.html:7

    I propose an alternative to also prevent a wording hitch, and make it a little bit more specific: ``` If this check reports any extension, you most move the section of <code>ext_tables.php</code> which extends the TCA inside a distinct file within the <code>Configuration/TCA/Overrides/</code> directory. Please refer to the documentation for details on proper file names and specific contents. ```

    TcaExtTablesCheck.html:9

    I think this could cause trouble if the link needs to remain stable. If the documentation on this is changed in i.e. TYPO3 v14, all T3v13 installations would links to the v14 documentation and probably mislead people. I'm not really sure how to best approach this, maybe the Docs team can give a best practice on that? Since a "v13" shortcut is not yet available for the docs, this would need changing before release...?
  5. core-ci voted on patch set 2 V +1 11/23/23, 10:58 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/49637

  6. Simon Schaufelberger commented on patch set 2 11/23/23, 11:39

    TcaExtTablesCheck.html:9 Reply

    Usually the decision is to not link to the documentation at all from the core because documentation can change any time ;)
  7. Nikita Hovratov commented on patch set 2 11/23/23, 12:35

    Cards.html:46

  8. Garvin Hicking commented on patch set 2 11/23/23, 12:41

    Cards.html:46 Reply

    True, good catch. Current core uses different casings, I found: Table configuration array Table Configuration Array Table Configuration array At least in the Documentation it's mostly the (right) way with all uppercase initials.
  9. Torben Hansen commented on patch set 2 11/23/23, 12:44

    Cards.html:46 Reply

    Good catch! Nobody noticed that since 6.2 :-)

    TcaExtTablesCheck.html:7 Reply

    Done

    TcaExtTablesCheck.html:9 Reply

    I removed the link
  10. Torben Hansen uploaded patch set 3 V +1 11/23/23, 12:44

  11. Torben Hansen uploaded patch set 4 11/23/23, 12:45

  12. Garvin Hicking commented on patch set 4 CR +1 V +1 11/23/23, 12:53

    Thanks. The smallest wording changes are always the hardest :D :D
  13. core-ci voted on patch set 3 V +1 11/23/23, 12:57 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/49678

  14. core-ci voted on patch set 4 V +1 11/23/23, 12:59 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/49679

  15. Christian Kuhn voted on patch set 4 CR +2 V +2 11/23/23, 15:12

  16. Christian Kuhn merged patch set 5 11/23/23, 15:12