Review main Merged

83521[DOCS] Fix References RST syntax containing angle brackets

Lina Wolf CR +2 V +2 Nightmare +1937 −1937 updated 03/21/24, 15:20

Commit message

Review

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

Issues 1

Files 558

Show 538 more files

Review log 1621

  1. Lina Wolf uploaded patch set 1 03/19/24, 12:06

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

  3. Garvin Hicking updated the commit message in patch set 2 V +1 03/19/24, 12:23

  4. core-ci voted on patch set 2 V +1 03/19/24, 12:28 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/54690

  5. Chris Müller commented on patch set 2 03/19/24, 16:56

    What about backporting to 11.5? I assume, this change is done because of the switch to guides? 11.5 will still be supported when we switch completely to guides, so there will be errors then in the 11.5 docs?
  6. Garvin Hicking commented on patch set 2 03/19/24, 17:17

    I think we should better replace something like: ``` prototypes.<prototypeIdentifier>. ``` with: ``` prototypes.[prototypeIdentifier] ``` ? If we remove the angle brackets completely, readers might not understand that a placeholder is meant at that place, and they may copy "prototypeIdentifier" into their YAML instead of knowing, they need to replace it with their own. An alternative could be to use :code:`<prototypeIdentifier>` or something like that, where angle brackets work again? Escaped angle brackets, I don't know how to replace them to not break rendering, but not "just removing" them...?
  7. Chris Müller commented on patch set 2 CR -1 03/19/24, 17:35

    Only angle brackets in references should be adjusted. In text (like .rst.txt) they should be kept, as this is a common usage for a placeholder.
  8. Lina Wolf marked it work in progress 03/20/24, 15:53

  9. Lina Wolf uploaded patch set 3 CR -1 V +1 03/20/24, 15:56

  10. core-ci voted on patch set 3 V +1 03/20/24, 16:01 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/54729

  11. Lina Wolf uploaded patch set 4 V +1 03/21/24, 14:40

  12. core-ci voted on patch set 4 V +1 03/21/24, 14:45 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/54806

  13. Lina Wolf uploaded patch set 5 V +1 03/21/24, 15:08

  14. Lina Wolf commented on patch set 4 03/21/24, 15:08

    This change is ready for review.
  15. Lina Wolf marked it ready for review 03/21/24, 15:08

  16. Lina Wolf commented on patch set 5 03/21/24, 15:11

    Reply

    I sorted them all by hand

    Reply

    I checked manually the changes in all 950 files
  17. Lina Wolf commented on patch set 5 03/21/24, 15:12

    Reply

    An automatic backport to 11.5 is not possible, also with the other changes. If a volunteer wants to prevent rendering errors in 11.5 of the form manual they can make a PR...
  18. core-ci voted on patch set 5 V +1 03/21/24, 15:15 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/54808

  19. Garvin Hicking commented on patch set 5 CR +1 V +1 03/21/24, 15:19

    Can't comment on the backport meccessity. The changes look great to me, I've browsed through all of them. I'm sorry you had to suffer through that, and thankful you could address this, thanks!! I hope this doesn't occur in other manuals too, else we may want to write a fixup-migration tool similar to settings-migration for it, and write automation for anchors and refs that wrongly reference this? Let me know once this comes up again in so many files.
  20. Lina Wolf voted on patch set 5 CR +2 V +2 03/21/24, 15:20

  21. Lina Wolf merged patch set 6 03/21/24, 15:20