Review main Merged

83264[DOCS] Streamline installation chapters of system extension manuals

Chris Müller CR +2 V +2 Hard +646 −232 updated 03/07/24, 12:17

Commit message

The content of the installation chapter of the various system
extension differs, some don't have an installation chapter. This
is now streamlined: now every installation chapter has the
Composer-based installation and the legacy installation described
in the same way.

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 39

Show 19 more files

Review log 1923

  1. Chris Müller uploaded patch set 1 03/06/24, 16:26

  2. Chris Müller updated the commit message in patch set 2 03/06/24, 16:27

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

  4. core-ci voted on patch set 2 V +1 03/06/24, 16:33 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/54055

  5. Garvin Hicking commented on patch set 2 CR +1 V +1 03/06/24, 21:49

    Great, cumbersome work - thanks!
  6. Lina Wolf commented on patch set 2 03/07/24, 06:02

    Thanks for taking the trouble to streamline this. Just some small remarks

    Index.rst:27

    Do we really want to copy all descriptions of the affected manuals here?

    Index.rst:10

    Is there a value in mentioning this?

    Index.rst:37

    should we mention the how to set the version? Cause if you have a TYPO3 v12.4 installation and 13.0 is already released you have to explicitly set the version
  7. Garvin Hicking commented on patch set 2 03/07/24, 08:39

    Index.rst:37 Reply

    The version constraints of cms-dashboard of the v13 release would contain a constraint to cms-core:13.0 - composer won't resolve that, so only a dashboard with cms-core:12.0 constraint would be added. IMO this streamlines the inclusion quite well, and we don't need to touch those documents in the future to adapt version strings here
  8. Lina Wolf commented on patch set 2 03/07/24, 08:41

    Index.rst:37 Reply

    Can we maybe link somewhere where dealing with versions is explained?
  9. Chris Müller uploaded patch set 3 CR +1 V +1 03/07/24, 11:12

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

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

    Index.rst:27 Reply

    It is the full line outputted from "composer show", so it does not hurt to have it.

    Index.rst:10 Reply

    It is already there in this manual, not only in the Installation part: https://docs.typo3.org/c/typo3/cms-dashboard/12.4/en-us/Configuration/Index.html When we remove this, this should be done in a separate patch (for all pages in all manuals).

    Index.rst:37 Reply

    I see no benefit: run "composer require" and the corresponding version is installed. That's it. No thinking about versions.
  12. Lina Wolf commented on patch set 3 03/07/24, 11:33

    Index.rst:27 Reply

    I think that it will give us more places to edit when descriptions change

    Index.rst:10 Reply

    I thought we were streamlining all Installation chapters. The others don't have this

    Index.rst:37 Reply

    composer require try to install the newest version and then tells you that it is not compatible with your project
  13. Chris Müller commented on patch set 3 03/07/24, 11:43

    Index.rst:10 Reply

    Yup, but it would be then inconsistent with the other pages of that manual. And: This topic (target groups) should be discussed separately.

    Index.rst:37 Reply

    That would only happen, when you want to require an outdated sysext, which is not compatible with your TYPO3 installation. Then you would get the same error, so no benefit. Like requiring typo3/cms-about:^9.5 in a 12.4 installation.
  14. Chris Müller uploaded patch set 4 V +1 03/07/24, 11:51

  15. Chris Müller commented on patch set 4 03/07/24, 11:52

    Index.rst:27 Reply

    Done
  16. Lina Wolf commented on patch set 4 03/07/24, 11:53

    Index.rst:10 Reply

    Acknowledged

    Index.rst:37 Reply

    Just tried it out and it indeed seems to work by now
  17. Lina Wolf commented on patch set 4 03/07/24, 11:55

    Index.rst:27 Reply

    Done
  18. core-ci voted on patch set 4 V +1 03/07/24, 11:56 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/54137

  19. Lina Wolf voted on patch set 4 CR +1 V +1 03/07/24, 11:57

  20. Lina Wolf commented on patch set 4 03/07/24, 11:57

    Good work, thank you
  21. Garvin Hicking voted on patch set 4 CR +1 V +1 03/07/24, 12:10

  22. Lina Wolf voted on patch set 4 CR +2 V +2 03/07/24, 12:17

  23. Lina Wolf merged patch set 5 03/07/24, 12:17