Review main Merged

84984[DOCS] Add details about how to extend the admin panel

Christian Reifenscheid CR +2 V +2 Easy +37 −8 updated 07/01/24, 09:13

Commit message

This commits adds the following hints:
* module classes needs to be set to public
* module classes needs to implement the ShortInfoProviderInterface
* description on how to add custom page settings
* description on how to add custom module settings

Review

  • Code review CR +2 Done
    • Stefan Bürk +2
    • Garvin Hicking +1
  • Verified V +2 Done
    • Stefan Bürk +2
    • Garvin Hicking +1
    • core-ci +1 CI

Issues 1

Files 1

Review log 1113

  1. Christian Reifenscheid uploaded patch set 1 06/28/24, 05:25

  2. core-ci voted on patch set 1 V +1 06/28/24, 05:30 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/60535

  3. Garvin Hicking commented on patch set 1 06/28/24, 09:31

    Thank you, this looks like important information! (Can't check atm but this sounds proper to me)

    Index.rst:51

    Was this removed intentionally? Because I think mentioning the order here could be useful and it still applies? I haven't created a new module for some time though ;)
  4. Christian Reifenscheid commented on patch set 1 06/28/24, 10:57

    Index.rst:51 Reply

    Yes, because 'after' had no effect and the custom module was added at the end; only 'before' worked. This was tested in versions 12.4.16 and 13.1.1.
  5. Garvin Hicking commented on patch set 1 06/28/24, 22:45

    Index.rst:51 Reply

    Probably "cache" is a problematic key because it doesn't show up always. Using before/after "info" might be better because that one is usually available. There before/affter works for me, does it do for you too? In that case maybe replace it here in this change and then keep the info about before/after, what do you think?
  6. Christian Reifenscheid commented on patch set 1 06/29/24, 06:45

    Index.rst:51 Reply

    I agree, that „cache“ is an unfavourable example. In my tests I used „tsdebug“ and „info“, but only „before“ worked. But if it worked in your tests, it seems that there are setups where everything is alright. So I think we shall keep it. This is my first core commit. Do I have to re-add and push again or is this something which can be done here? Thank you for the review and the exchange and of course your help!
  7. Garvin Hicking commented on patch set 1 06/29/24, 08:29

    Index.rst:51 Reply

    That's great, thank you for taking the time to setup your contribution, much appreciated :-) If you still have your GIT working directory with the latest state when you committed, you can edit that file again and afterwards to "git commit . --amend". The "amend" is the important thing (otherwise a new patch would be created). After the commit you push normaly like the first time. If you already resettet your git state somehow, you can do: ``` git fetch --all git reset --hard origin/main git fetch https://review.typo3.org/Packages/TYPO3.CMS refs/changes/84/84984/1 && git cherry-pick FETCH_HEAD vi typo3/sysext/adminpanel/Documentation/Extending/Index.rst # do the editing stuff git commit . --amend git push ``` Now to explain how I tested my thing, I took `typo3/sysext/adminpanel/ext_localconf.php` where the initial module configuration is and took this block: ``` 'debug' => [ 'module' => DebugModule::class, 'after' => ['info'], ``` and then changed 'before' to 'after', reloaded the admin panel, and saw that the 'debug' menu item shifted places. Then I changed to "before=tsdebug" and that also worked. Because before/after may have several dependencies, maybe you used an unlucky combination when you tested it?
  8. Christian Reifenscheid uploaded patch set 2 V +1 07/01/24, 06:33

  9. Christian Reifenscheid commented on patch set 2 07/01/24, 06:36

    Index.rst:51 Reply

    Hi Garvin, many thanks for your guidance. I really appreciate it! I have added back the explanation for "before" and "after.
  10. core-ci voted on patch set 2 V +1 07/01/24, 06:39 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/60727

  11. Garvin Hicking commented on patch set 2 CR +1 V +1 07/01/24, 06:42

    Index.rst:51 Reply

    Great! This looks good to me! If you want, you can post a link to your patch on the typo3-cms-coredec slack channel to gather some votes? 😊
  12. Stefan Bürk voted on patch set 2 CR +2 V +2 07/01/24, 07:58

  13. Stefan Bürk merged patch set 3 07/01/24, 09:13