Review main Merged

83316[DOCS] Switch Low Level documentation to PHP-based rendering

Lina Wolf CR +2 V +2 Normal +22 −193 updated 03/09/24, 17:15

Commit message

* Introduce a guides.xml, the presence of this file
  triggers the new rendering.
* Remove superfluous genindex, it is not supported anymore
* Remove old Settings.cfg, was only used for Sphinx

Attention: Backports need manual changes to the guides.xml.

Review

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

Issues 1

Files 6

Review log 2124

  1. Lina Wolf uploaded patch set 1 03/07/24, 18:23

  2. core-ci voted on patch set 1 V +1 03/07/24, 18:35 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/54174

  3. Chris Müller commented on patch set 1 03/07/24, 19:03

    ManageReferenceIndex.rst:13

    Hmm, I don't like using t3install over t3upgrade: It is the Upgrade Guide, not the Installation Guide (which is in Getting Started). I changed that some months ago in all the Settings.cfg.
  4. Lina Wolf commented on patch set 1 03/08/24, 05:48

    we defined the manual as t3install in the render guides. I took all names from how-to-document: https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html#settings-documentation-settings-cfg
  5. Chris Müller commented on patch set 1 03/08/24, 17:11

    Reply

    In my opinion this is wrong, as it not about installation, but upgrading which might confuse. I streamlined it months ago in all manuals and also the extension manual skeleton (which was the single source of truth for me).
  6. Lina Wolf commented on patch set 1 03/08/24, 17:14

    Reply

    That is something you would have to change in the render-guides then, not in this sole manual?
  7. Chris Müller commented on patch set 1 03/08/24, 17:24

    Reply

    Yup, this will be not the only manual which has to be adjusted to the other key. I suggest to provide t3upgrade and t3install (as 3rd-party extension manuals may have t3install also) - with t3install to be considered as legacy.
  8. Lina Wolf commented on patch set 1 03/08/24, 17:28

    ManageReferenceIndex.rst:13 Reply

    As stated bellow this is the default from the render-guides and the how-to-document.
  9. Chris Müller commented on patch set 1 CR -1 03/08/24, 18:16

    Includes.rst.txt wasn't updated.

    ManageReferenceIndex.rst:13 Reply

    Yup, then we add also the t3upgrade? Otherwise we have to mention in the migration guide, that "t3upgrade" for the Upgrade Guide must be changed to "t3install" which looks really odd.
  10. Chris Müller commented on patch set 1 03/08/24, 18:34

    ManageReferenceIndex.rst:13 Reply

  11. Chris Müller uploaded patch set 2 CR -1 V +1 03/08/24, 18:36

  12. Chris Müller commented on patch set 2 03/08/24, 18:39

    Reply

    Done
  13. core-ci voted on patch set 2 V +1 03/08/24, 18:42 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/54300

  14. Chris Müller commented on patch set 2 03/08/24, 18:44

  15. Lina Wolf marked it work in progress 03/09/24, 05:43

  16. Lina Wolf commented on patch set 2 03/09/24, 05:43

    This change is ready for review.
  17. Lina Wolf marked it work in progress 03/09/24, 05:43

  18. Lina Wolf uploaded patch set 3 V +1 03/09/24, 10:26

  19. Lina Wolf marked it ready for review 03/09/24, 10:26

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

  21. Chris Müller voted on patch set 3 CR +1 V +1 03/09/24, 16:22

  22. Lina Wolf voted on patch set 3 CR +2 V +2 03/09/24, 17:06

  23. Lina Wolf merged patch set 4 03/09/24, 17:06

  24. Lina Wolf commented on patch set 4 03/09/24, 17:15

    Docs did not exist in 11.5 yet, omitting backport