Review main Merged

83171[DOCS] Switch adminpanel docs to PHP-based rendering

Lina Wolf CR +2 V +2 Normal +28 −120 updated 03/01/24, 19:26

Commit message

* Introduce a guides.xml, the presence of this file
  triggers the new rendering.
* Replace sphinx-only syntax
* 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
    • Benni Mack +1
  • Verified V +2 Done
    • Lina Wolf +2
    • Chris Müller +1
    • Benni Mack +1
    • core-ci +1 CI

Issues 1

Files 6

Review log 1315

  1. Lina Wolf uploaded patch set 1 03/01/24, 11:30

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

  3. Chris Müller commented on patch set 1 CR -1 03/01/24, 11:56

    Index.rst:40

    This should be :ref:tsconfig-admpanel-enable
  4. Lina Wolf uploaded patch set 2 CR -1 V +1 03/01/24, 11:59

  5. Lina Wolf commented on patch set 2 03/01/24, 11:59

    Index.rst:40 Reply

    Done
  6. Chris Müller voted on patch set 2 CR +1 V +1 03/01/24, 12:03

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

  8. Chris Müller commented on patch set 2 03/01/24, 12:14

    For those who want to test: 1. Switch to the adminpanel directory 2. execute: docker run --rm --pull always -v $(pwd):/project -it ghcr.io/typo3-documentation/render-guides:latest --config=Documentation
  9. Chris Müller commented on patch set 2 03/01/24, 12:17

  10. Benni Mack voted on patch set 2 CR +1 V +1 03/01/24, 15:39

  11. Garvin Hicking commented on patch set 2 03/01/24, 18:06

    is the backport down to 12 and 11 intentional? That would mean rendering all these versions with the new one, are we prime-time already for core-docs? If so, when backporting, the guides.xml needs adaptation then for the relative correct branches.
  12. Chris Müller commented on patch set 2 03/01/24, 18:42

    Reply

    IMHO we should go for the LTS versions - we have to start anyway at some time. The rendered manual looked good and we can retrigger the rendering later, if we really have to. Otherwise we have to start a review again for the LTS versions. And I assume, Lina will take care of adapting the version in the settings on backporting.
  13. Lina Wolf commented on patch set 2 03/01/24, 19:26

    Reply

    I will take care of the backporting
  14. Lina Wolf voted on patch set 2 CR +2 V +2 03/01/24, 19:26

  15. Lina Wolf merged patch set 3 03/01/24, 19:26