Review main Merged

85742[DOCS] Convert EXT:dashboard syntax from options to confvals

Lina Wolf CR +2 V +2 Hard +221 −141 updated 09/04/24, 15:14

Commit message

This fixes the rendering warnings due to duplicate anchors
and provides more structure in general. Also utilize
API docs referencing for FQCNs.

Review

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

Issues 1

Files 11

Review log 2638

Show 813 earlier messages
  1. Lina Wolf uploaded patch set 1 08/23/24, 02:11

  2. core-ci voted on patch set 1 V +1 08/23/24, 02:19 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/64030

  3. Garvin Hicking updated the commit message in patch set 2 V +1 08/23/24, 05:04

  4. core-ci voted on patch set 2 V +1 08/23/24, 05:12 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/64041

  5. Chris Müller commented on patch set 2 CR -1 08/23/24, 06:24

    WidgetRegistration.rst:180

    As stated above, this is optional, so no ":required:"

    WidgetRegistration.rst:188

    As stated above, this is optional, so no ":required:"

    WidgetRegistration.rst:196

    As stated above, this is optional, so no ":required:"

    BarChartWidget.rst:62

    Above php-short is used, here php, please stay consistent.

    DoughnutChartWidget.rst:48

    Sometimes you use php-sort, sometimes php, please stay consistent.

    DoughnutChartWidget.rst:57

    here too

    NumberWithIconWidget.rst:61

    e.g. is superfluous

    NumberWithIconWidget.rst:74

    Sometimes you use php-class, sometimes php, please stay consistent.

    RssWidget.rst:87

    Sometimes you use php-class, sometimes php, please stay consistent.
  6. Lina Wolf commented on patch set 2 08/23/24, 06:32

    BarChartWidget.rst:62 Reply

    Please have a look at how the php-short syntax works: https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/Reference/ReStructuredText/Links/Api.html#links-api-short If we fully print out the FQN once in the same context it should be sufficient to mention it by its short name in subsequent mentionings in the same paragraph.

    DoughnutChartWidget.rst:48 Reply

    See above

    DoughnutChartWidget.rst:57 Reply

    See above

    NumberWithIconWidget.rst:74 Reply

    See above

    RssWidget.rst:87 Reply

    See above
  7. Lina Wolf commented on patch set 3 CR -1 V +1 08/23/24, 06:33

    Published edit on patch set 2.
  8. Lina Wolf commented on patch set 3 08/23/24, 06:33

    WidgetRegistration.rst:180 Reply

    Good catch

    WidgetRegistration.rst:188 Reply

    Done

    WidgetRegistration.rst:196 Reply

    Done
  9. Lina Wolf commented on patch set 4 08/23/24, 06:34

    Published edit on patch set 3.
  10. Lina Wolf commented on patch set 4 08/23/24, 06:34

    NumberWithIconWidget.rst:61 Reply

    Done
  11. core-ci voted on patch set 3 V +1 08/23/24, 06:39 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/64047

  12. core-ci voted on patch set 4 V -1 08/23/24, 06:42 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/64048

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

  1. Chris Müller commented on patch set 4 08/23/24, 07:11

    BarChartWidget.rst:62 Reply

    So, given that example on that page: ChartDataProviderInterface is short, but ButtonProviderInterface uses the FQCN. Why? The ChartDataProviderInterface is not mentioned above with FQCN (when we agree to omit the FQCN on consecutive occurrences. This is inconsistent and as a user I ask myself? Why once with FQCN and once not (for the same structure here).
  2. Lina Wolf commented on patch set 5 V +1 08/23/24, 07:16

    Published edit on patch set 4.
  3. Lina Wolf commented on patch set 5 08/23/24, 07:16

    BarChartWidget.rst:62 Reply

    Yes the first mention should be a full FQN. Fixed it
  4. core-ci voted on patch set 5 V +1 08/23/24, 07:27 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/64051

  5. Garvin Hicking commented on patch set 5 CR +1 V +1 08/26/24, 08:48

    This seems fine for me now, @typo3@brotkrueml.dev ?
  6. Garvin Hicking uploaded patch set 6 CR +1 V +1 08/26/24, 08:48

  7. Garvin Hicking voted on patch set 6 CR +1 V +1 08/26/24, 08:49

  8. core-ci voted on patch set 6 V +1 08/26/24, 08:55 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/64182

  9. Lina Wolf commented on patch set 6 08/26/24, 09:49

    BarChartWidget.rst:62 Reply

    Done
  10. Garvin Hicking rebased onto patch set 7 CR +1 V +1 08/26/24, 21:11

  11. Garvin Hicking voted on patch set 7 CR +1 V +1 08/26/24, 21:12

  12. core-ci voted on patch set 7 V -1 08/26/24, 21:19 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/64254

  13. core-ci voted on patch set 7 V +1 08/27/24, 05:29 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/64254

  14. Chris Müller voted on patch set 7 CR +1 V +1 08/30/24, 18:26

  15. Garvin Hicking commented on patch set 7 08/31/24, 08:32

    (needs conflict resolving on cherry picks, will do next week)
  16. Lina Wolf uploaded patch set 8 CR +1 V +1 08/31/24, 11:56

  17. Lina Wolf uploaded patch set 9 08/31/24, 12:00

  18. core-ci voted on patch set 8 V -1 08/31/24, 12:05 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/64585

  19. core-ci voted on patch set 8 V +1 08/31/24, 12:11 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/64585

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

  21. Garvin Hicking commented on patch set 9 CR +1 V +1 09/04/24, 14:33

    Thanks for cherry-picking; 11.5 is yet open, 12.4+main seems good to me! :)
  22. Benni Mack voted on patch set 9 CR +1 V +1 09/04/24, 15:03

  23. Garvin Hicking voted on patch set 9 CR +2 V +2 09/04/24, 15:12

  24. Garvin Hicking merged patch set 10 09/04/24, 15:12

  25. Garvin Hicking commented on patch set 10 09/04/24, 15:14

    (merge note: will delay 11.5 cherry-pick a bit, but wanted to fix rendering warnings for main+12 at least already)