Review 11.5 Merged

85697[DOCS] Fix wrongly merged Syntax of EXT:dashboard documentation

TYPO3com CR +2 V +2 Normal +8 −65 updated 08/22/24, 13:09

Commit message

A broken backport for #103298 introduced some
not properly resolved changes.

This patch removes the wrongly merged blocks and
further adjusts indentation and class schemes
for the 11.5 context.

Review

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

Issues 2

Files 4

Review log 1822

  1. TYPO3com uploaded patch set 1 08/20/24, 13:24

  2. Sandra Erbel voted on patch set 1 CR +1 V +1 08/20/24, 13:27

  3. core-ci voted on patch set 1 V +1 08/20/24, 13:32 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/63833

  4. Andreas Kienast commented on patch set 1 CR -1 08/20/24, 13:47

    WidgetImplementation.rst:139

    This looks wrong. It's about `JavaScriptInterface` (which is fine for v11) but the example below implements `RequireJsModuleInterface`.
  5. Christian Kuhn updated the commit message in patch set 2 CR +1 V +1 08/20/24, 13:48

  6. Christian Kuhn commented on patch set 2 CR -1 08/20/24, 13:49

  7. Christian Kuhn commented on patch set 2 08/20/24, 13:49

    Reply

    please review the entire offending patch again,
  8. core-ci voted on patch set 2 V +1 08/20/24, 13:56 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/63834

  9. Sandra Erbel commented on patch set 2 CR -1 08/20/24, 14:43

    WidgetImplementation.rst:139 Reply

    I guess the the correct example is more downstairs. I think this happened because there are still old changes left from the other branch conflicted with another branch at that time. See the current documentation page: https://docs.typo3.org/c/typo3/cms-dashboard/11.5/en-us/Developer/WidgetImplementation.html#implement-new-widget
  10. Garvin Hicking commented on patch set 2 08/20/24, 15:46

    The affected files are: typo3/sysext/dashboard/Documentation/Developer/WidgetImplementation.rst typo3/sysext/dashboard/Documentation/Widgets/ListWidget.rst typo3/sysext/dashboard/Documentation/Widgets/NumberWithIconWidget.rst Caused in: https://review.typo3.org/c/Packages/TYPO3.CMS/+/83237
  11. Chris Müller commented on patch set 2 08/21/24, 16:12

    What about reverting the whole change for v11.5. And then a new PR which changes just the rendering and nothing optional (which is not needed for that change).
  12. Garvin Hicking uploaded patch set 3 CR -1 V +1 08/21/24, 20:19

    Fixup
  13. Garvin Hicking commented on patch set 3 CR +1 V +1 08/21/24, 20:23

    Reply

    Done

    Reply

    I went through the changes manually and found it easier to only fix the broken places at this time, to not have a revert+fixup commit just for the smaller parts, and integrate all of the proper changes of the original patch commit. If someone wants to clean this up differently, I won't mind. This was hard to comb through 😄
    The current rendering throws some warnings (which it already did before, I guess it's out of scope?): ``` [2024-08-21T20:16:57.551938+00:00] app.WARNING: Duplicate anchor "title" for link type "std:option" in document "Configuration/WidgetRegistration". The anchor is already used at "Configuration/WidgetPresets" {"rst-file":"Configuration/WidgetRegistration.rst"} [] [2024-08-21T20:16:57.553232+00:00] app.WARNING: Duplicate anchor "description" for link type "std:option" in document "Configuration/WidgetRegistration". The anchor is already used at "Configuration/WidgetPresets" {"rst-file":"Configuration/WidgetRegistration.rst"} [] [2024-08-21T20:16:57.553292+00:00] app.WARNING: Duplicate anchor "iconidentifier" for link type "std:option" in document "Configuration/WidgetRegistration". The anchor is already used at "Configuration/WidgetPresets" {"rst-file":"Configuration/WidgetRegistration.rst"} [] [2024-08-21T20:16:57.553595+00:00] app.WARNING: Duplicate anchor "title" for link type "std:option" in document "Developer/AddingButtons". The anchor is already used at "Configuration/WidgetPresets" {"rst-file":"Developer/AddingButtons.rst"} [] [2024-08-21T20:16:57.556014+00:00] app.WARNING: Duplicate anchor "refreshavailable" for link type "std:option" in document "Widgets/BarChartWidget". The anchor is already used at "Developer/MakeRefreshable" {"rst-file":"Widgets/BarChartWidget.rst"} [] [2024-08-21T20:16:57.556119+00:00] app.WARNING: Duplicate anchor "refreshavailable" for link type "std:option" in document "Widgets/CTAButtonWidget". The anchor is already used at "Developer/MakeRefreshable" {"rst-file":"Widgets/CTAButtonWidget.rst"} [] [2024-08-21T20:16:57.556143+00:00] app.WARNING: Duplicate anchor "buttonprovider" for link type "std:option" in document "Widgets/CTAButtonWidget". The anchor is already used at "Widgets/BarChartWidget" {"rst-file":"Widgets/CTAButtonWidget.rst"} [] [2024-08-21T20:16:57.556160+00:00] app.WARNING: Duplicate anchor "view" for link type "std:option" in document "Widgets/CTAButtonWidget". The anchor is already used at "Widgets/BarChartWidget" {"rst-file":"Widgets/CTAButtonWidget.rst"} [] [2024-08-21T20:16:57.556272+00:00] app.WARNING: Duplicate anchor "refreshavailable" for link type "std:option" in document "Widgets/DoughnutChartWidget". The anchor is already used at "Developer/MakeRefreshable" {"rst-file":"Widgets/DoughnutChartWidget.rst"} [] [2024-08-21T20:16:57.556336+00:00] app.WARNING: Duplicate anchor "dataprovider" for link type "std:option" in document "Widgets/DoughnutChartWidget". The anchor is already used at "Widgets/BarChartWidget" {"rst-file":"Widgets/DoughnutChartWidget.rst"} [] [2024-08-21T20:16:57.556364+00:00] app.WARNING: Duplicate anchor "buttonprovider" for link type "std:option" in document "Widgets/DoughnutChartWidget". The anchor is already used at "Widgets/BarChartWidget" {"rst-file":"Widgets/DoughnutChartWidget.rst"} [] [2024-08-21T20:16:57.556396+00:00] app.WARNING: Duplicate anchor "view" for link type "std:option" in document "Widgets/DoughnutChartWidget". The anchor is already used at "Widgets/BarChartWidget" {"rst-file":"Widgets/DoughnutChartWidget.rst"} [] [2024-08-21T20:16:57.556572+00:00] app.WARNING: Duplicate anchor "refreshavailable" for link type "std:option" in document "Widgets/ListWidget". The anchor is already used at "Developer/MakeRefreshable" {"rst-file":"Widgets/ListWidget.rst"} [] [2024-08-21T20:16:57.556600+00:00] app.WARNING: Duplicate anchor "dataprovider" for link type "std:option" in document "Widgets/ListWidget". The anchor is already used at "Widgets/BarChartWidget" {"rst-file":"Widgets/ListWidget.rst"} [] [2024-08-21T20:16:57.556614+00:00] app.WARNING: Duplicate anchor "view" for link type "std:option" in document "Widgets/ListWidget". The anchor is already used at "Widgets/BarChartWidget" {"rst-file":"Widgets/ListWidget.rst"} [] [2024-08-21T20:16:57.556732+00:00] app.WARNING: Duplicate anchor "refreshavailable" for link type "std:option" in document "Widgets/NumberWithIconWidget". The anchor is already used at "Developer/MakeRefreshable" {"rst-file":"Widgets/NumberWithIconWidget.rst"} [] [2024-08-21T20:16:57.556754+00:00] app.WARNING: Duplicate anchor "title" for link type "std:option" in document "Widgets/NumberWithIconWidget". The anchor is already used at "Configuration/WidgetPresets" {"rst-file":"Widgets/NumberWithIconWidget.rst"} [] [2024-08-21T20:16:57.556778+00:00] app.WARNING: Duplicate anchor "dataprovider" for link type "std:option" in document "Widgets/NumberWithIconWidget". The anchor is already used at "Widgets/BarChartWidget" {"rst-file":"Widgets/NumberWithIconWidget.rst"} [] [2024-08-21T20:16:57.556832+00:00] app.WARNING: Duplicate anchor "view" for link type "std:option" in document "Widgets/NumberWithIconWidget". The anchor is already used at "Widgets/BarChartWidget" {"rst-file":"Widgets/NumberWithIconWidget.rst"} [] [2024-08-21T20:16:57.556922+00:00] app.WARNING: Duplicate anchor "refreshavailable" for link type "std:option" in document "Widgets/RssWidget". The anchor is already used at "Developer/MakeRefreshable" {"rst-file":"Widgets/RssWidget.rst"} [] [2024-08-21T20:16:57.556978+00:00] app.WARNING: Duplicate anchor "buttonprovider" for link type "std:option" in document "Widgets/RssWidget". The anchor is already used at "Widgets/BarChartWidget" {"rst-file":"Widgets/RssWidget.rst"} [] [2024-08-21T20:16:57.556998+00:00] app.WARNING: Duplicate anchor "view" for link type "std:option" in document "Widgets/RssWidget". The anchor is already used at "Widgets/BarChartWidget" {"rst-file":"Widgets/RssWidget.rst"} [] ```

    WidgetImplementation.rst:139 Reply

    Done
  14. Garvin Hicking commented on patch set 3 08/21/24, 20:24

    Reply

    Done
  15. core-ci voted on patch set 3 V +1 08/21/24, 20:27 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/63936

  16. Lina Wolf commented on patch set 3 CR +1 V +1 08/22/24, 06:18

    Thanks a lot for cleaning up my mess!!
  17. Garvin Hicking commented on patch set 3 08/22/24, 07:06

    Reply

    Note: These also appear in main and 12. This needs a specific isoloated patch as a follow-up (and seperate backport), replacing options with confvals. Lina is aware of this, so this is irrelevant for this patch now.
  18. Sandra Erbel commented on patch set 3 CR +1 V +1 08/22/24, 10:33

    Thank you for cleaning up.
  19. Christian Kuhn voted on patch set 3 CR +1 08/22/24, 12:56

  20. Christian Kuhn commented on patch set 3 08/22/24, 12:56

    Reply

    yeah. let's get it fixed this way and be fine.
  21. Garvin Hicking voted on patch set 3 CR +2 V +2 08/22/24, 13:09

  22. Garvin Hicking merged patch set 4 08/22/24, 13:09