Review main Merged

85749[DOCS] Fix YAML syntax highlighting in EXT:dashboard examples

Philipp Kuhlmay CR +2 V +2 Hard +202 −198 updated 08/26/24, 16:35

Commit message

This sets the correct code-block caption definitions for the YAML
and PHP code blocks so they will be rendered correctly.

Review

  • Code review CR +2 Done
    • Garvin Hicking +2
    • Chris Müller +1
  • Verified V +2 Done
    • Garvin Hicking +2
    • Chris Müller +1
    • core-ci +1 CI

Issues 1

Files 9

Review log 2127

Show 12 earlier messages
  1. Philipp Kuhlmay uploaded patch set 1 08/23/24, 13:23

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

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

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

  3. Chris Müller commented on patch set 2 08/23/24, 16:03

    on it
  4. Chris Müller uploaded patch set 3 V +1 08/23/24, 16:23

  5. Chris Müller commented on patch set 3 08/23/24, 16:24

    Reply

    Done
  6. core-ci voted on patch set 3 V +1 08/23/24, 16:28 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/64091

  7. Chris Müller voted on patch set 3 CR +1 V +1 08/23/24, 16:44

  8. Garvin Hicking commented on patch set 3 CR +1 V +1 08/23/24, 17:14

    will backport, probably merge conflicts and some missing markups in v11
  9. Garvin Hicking uploaded patch set 4 CR +1 V +1 08/26/24, 09:28

    Fix captions to refer to custom extension
  10. Garvin Hicking commented on patch set 4 CR +1 V +1 08/26/24, 09:29

    The caption was off and didn't refer to "my_extension" but a file that should not be edited.
  11. Chris Müller commented on patch set 4 CR -1 08/26/24, 09:34

    Reply

    I disagree: The code snippets are taken right from EXT:dashboard - and EXT:dashoard was used by intention. In your own extension you won't use a service name like "dashboard.widget.sysLogErrors".
  12. core-ci voted on patch set 4 V +1 08/26/24, 09:34 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/64189

  13. Garvin Hicking commented on patch set 4 CR 0 V 0 08/26/24, 13:18

    Reply

    The docs always mention "your own" file in "Configuration..." so I think generally this should apply. Captioning the files with EXT:dashboard would suggest that you edit exactly that file, and not one in your own extension which that file serves as an example for? I did not work enough with dashboard widgets. I cannot authoritatively review this then, only point out that before the patch, the files seem not fixed to EXT:dashboard, but to a custom extension to me?
  14. Chris Müller commented on patch set 4 08/26/24, 13:54

    Reply

    Then a solution may be to use a caption like: "Example from EXT:dashboard/..."
  15. Chris Müller commented on patch set 4 08/26/24, 14:07

    Reply

    Another possibility may be to revert the caption part and leave as is like before the patch. The main pain point was that the snippet was not correctly rendered. Was just mentioning "Configuration/Services.yaml" in the text above (which is more unclear than the current solution IMHO). The caption can then be tackled in a separate patch.
  16. Garvin Hicking commented on patch set 4 08/26/24, 15:53

    Reply

    The "Example from EXT..." notation would be fine by me, that's a good suggestion. I probably won't find time to do this in the main patch and the two backports the next days, but will try to fit it into this week. If you or Philipp want to take an earlier stab at it, I would be grateful.
  17. Chris Müller uploaded patch set 5 CR -1 V +1 08/26/24, 16:13

  18. Chris Müller commented on patch set 5 08/26/24, 16:13

    Reply

    Done
  19. Chris Müller uploaded patch set 6 08/26/24, 16:16

  20. core-ci voted on patch set 5 V +1 08/26/24, 16:24 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/64226

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

  22. Garvin Hicking commented on patch set 6 CR +1 V +1 08/26/24, 16:29

    Awesome, thank you!
  23. Chris Müller voted on patch set 6 CR +1 V +1 08/26/24, 16:33

  24. Garvin Hicking voted on patch set 6 CR +2 V +2 08/26/24, 16:35

  25. Garvin Hicking merged patch set 7 08/26/24, 16:35