Review main Merged

63754[DOCS] Add documentation for ext:dashboard

Daniel Siepmann CR +2 V +2 Expert +1817 −0 updated 04/17/20, 07:40

Commit message

Initial documentation covering basic editor, integrator and developer
tasks.

Review

  • Code review CR +2 Done
    • Susi Moog +2
    • Georg Ringer +1
    • Richard Haeser +1
  • Verified V +2 Done
    • Susi Moog +2
    • Georg Ringer +1
    • Richard Haeser +1
    • TYPO3com +1 CI

Issues 1

Files 33

Show 13 more files

Review log 3550

Show 1625 earlier messages
  1. Daniel Siepmann uploaded patch set 1 03/16/20, 21:06

  2. Daniel Siepmann marked it work in progress 03/16/20, 21:07

  3. TYPO3com voted on patch set 1 V -1 03/16/20, 21:28 Completed build in 21m 56s on Mon, 16 Mar, 09:28 PM Test Summary: 72159 passed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-1386

  4. Daniel Siepmann uploaded patch set 2 03/20/20, 13:37

  5. TYPO3com voted on patch set 2 V +1 03/20/20, 13:48 Completed build in 10m 57s on Fri, 20 Mar, 01:48 PM Test Summary: 72120 passed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-1502

  6. Daniel Siepmann uploaded patch set 3 03/20/20, 17:26

  7. TYPO3com voted on patch set 3 V +1 03/20/20, 17:39 Completed build in 12m 29s on Fri, 20 Mar, 05:39 PM Test Summary: 72123 passed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-1519

  8. Daniel Siepmann wrote 03/20/20, 19:30

    Set private
  9. Daniel Siepmann uploaded patch set 4 03/20/20, 20:08

  10. TYPO3com voted on patch set 4 V +1 03/20/20, 20:24 Completed build in 15m 53s on Fri, 20 Mar, 08:24 PM Test Summary: 72123 passed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-1525

  11. Daniel Siepmann wrote 03/21/20, 13:54

    Unset private
  12. Daniel Siepmann uploaded patch set 5 03/21/20, 14:03

  13. TYPO3com voted on patch set 5 V +1 03/21/20, 14:14 Completed build in 11m 00s on Sat, 21 Mar, 02:14 PM Test Summary: 72231 passed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-1541

  14. Daniel Siepmann uploaded patch set 6 03/24/20, 12:19

  15. TYPO3com voted on patch set 6 V +1 03/24/20, 12:36 Completed build in 17m 15s on Tue, 24 Mar, 12:36 PM Test Summary: 73014 passed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-1666

  16. Daniel Siepmann uploaded patch set 7 03/25/20, 14:05

  17. TYPO3com voted on patch set 7 V -1 03/25/20, 14:17 Completed build in 11m 04s on Wed, 25 Mar, 02:17 PM Test Summary: 21 of 73504 failed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-1711

  18. Daniel Siepmann uploaded patch set 8 03/25/20, 21:24

  19. TYPO3com voted on patch set 8 V +1 03/25/20, 21:39 Completed build in 13m 22s on Wed, 25 Mar, 09:39 PM Test Summary: 73017 passed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-1729

  20. Richard Haeser commented on patch set 8 04/03/20, 09:55

    WidgetRegistration.rst:54

    Height and width needs to be 'small', 'medium' or 'large'

    WidgetRegistration.rst:143

    Height and width needs to be 'small', 'medium' or 'large'
  21. Susi Moog commented on patch set 8 04/03/20, 10:50

    WidgetRegistration.rst:42

    $cache: '@cache.dashboard.rss'

    WidgetRegistration.rst:54

    width / height settings need adjustment

    WidgetRegistration.rst:84

    can I configure the button URL (and just that?) I don't want an own provider, but my own link.

    WidgetRegistration.rst:116

    how do I add a custom group?

    WidgetRegistration.rst:143

    height/width again.

    WidgetTemplate.rst:11

    please add the file / module where to add the snippets (I usually struggle with such things in docs)

    WidgetImplementation.rst:59

    the configuration is hopefully not a view.

    WidgetImplementation.rst:91

    populate

    WidgetImplementation.rst:179

    we should be consistent with the namespaces throughout the example and maybe add the services.yaml file for this concrete example here, just to have it complete in one place.
  22. Susi Moog commented on patch set 8 04/03/20, 11:06

    WidgetImplementation.rst:63

    probably the example should be updated as a whole.
  23. Daniel Siepmann uploaded patch set 9 04/03/20, 12:17

  24. TYPO3com voted on patch set 9 V +1 04/03/20, 12:29 Completed build in 11m 50s on Fri, 3 Apr, 12:29 PM Test Summary: 73258 passed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-2122

  25. Daniel Siepmann commented on patch set 9 04/03/20, 12:29

    WidgetRegistration.rst:42 Reply

    Done

    WidgetRegistration.rst:54 Reply

    Done

    WidgetRegistration.rst:54 Reply

    Done

    WidgetRegistration.rst:84 Reply Unresolved

    You always need to configure the provider, but there is no need to implement a new provider. This is partly covered by "Adding button to Widget" in Developers/AddingButtons.rst (https://tmp.daniel-siepmann.de/projects/typo3/63563/docs/Developer/AddingButtons.html) But should also be added to Widgets/RssWidget.rst

    WidgetRegistration.rst:116 Reply Unresolved

    I've added a cross reference to Configuration/WidgetGroupCreation.rst and added some more info. Also WidgetGroupCreation.rst was moved from developers to configuration. I hope that is enough?

    WidgetRegistration.rst:143 Reply

    Done

    WidgetRegistration.rst:143 Reply

    Done

    WidgetTemplate.rst:11 Reply Unresolved

    Yeah it is TypoScript, so a bit hard as there are so many different possibilities. I've tried to cover the database approach (none best practice) and added a reference to the sitepackage tutorial. Hope this is enough? Right now "Core API" does not have a single chapter covering this, which would be a nice to have as a reference.

    WidgetImplementation.rst:59 Reply

    Done

    WidgetImplementation.rst:63 Reply

    Done

    WidgetImplementation.rst:91 Reply

    Done

    WidgetImplementation.rst:179 Reply Unresolved

    Yeah we can do that. But I would like to not duplicate that part, as this would be the registration which is separated from the implementation. What do you think?
  1. Daniel Siepmann commented on patch set 9 04/03/20, 15:16

    This change is ready for review.
  2. Daniel Siepmann uploaded patch set 10 04/04/20, 09:33

  3. TYPO3com voted on patch set 10 V +1 04/04/20, 09:45 Completed build in 12m 07s on Sat, 4 Apr, 09:45 AM Test Summary: 73288 passed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-2153

  4. Richard Haeser uploaded patch set 11 04/07/20, 19:19

  5. Richard Haeser commented on patch set 11 04/07/20, 19:20

    Tomorrow I will continue adding info for the other widgets.
  6. TYPO3com voted on patch set 11 V -1 04/07/20, 19:31 Completed build in 11m 48s on Tue, 7 Apr, 07:31 PM Test Summary: 73056 passed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-2283

  7. Richard Haeser uploaded patch set 12 04/14/20, 21:50

  8. TYPO3com voted on patch set 12 V +1 04/14/20, 22:02 Completed build in 11m 44s on Tue, 14 Apr, 10:02 PM Test Summary: 73520 passed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-2539

  9. Richard Haeser uploaded patch set 13 04/15/20, 20:29

  10. Richard Haeser commented on patch set 13 04/15/20, 20:29

    A rendered version of the docs can be found on https://www.richardhaeser.com/docs/dashboard/Index.html
  11. TYPO3com voted on patch set 13 V +1 04/15/20, 20:47 Completed build in 14m 28s on Wed, 15 Apr, 08:47 PM Test Summary: 73571 passed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-2610

  12. Oli Bartsch commented on patch set 13 04/15/20, 21:09

    Some suggestions for now. Will have a look at the remaining pages tomorrow.

    Index.rst:27 Unresolved

    corresponding

    Index.rst:38 Unresolved

    the default preset, which

    Index.rst:53 Unresolved

    are the icons

    Index.rst:59 Unresolved

    of the tab bar

    Index.rst:60 Unresolved

    the currently

    Index.rst:68 Unresolved

    Dashboards which do not contain any widget yet, offer a dialog in the middle of the screen, which allows to add one or more widgets to the current dashboard.

    Index.rst:79

    widgets

    Index.rst:94 Unresolved

    some

    Index.rst:110 Unresolved

    some

    Index.rst:112 Unresolved

    appears

    Index.rst:119 Unresolved

    deletion, a modal is shown

    Index.rst:120 Unresolved

    by

    Index.rst:27 Unresolved

    dashboard

    Index.rst:42 Unresolved

    the extension is already shipped. You just have to activate it.
  13. Jonas Eberle voted on patch set 13 V +1 04/15/20, 21:38

  14. Benjamin Franzke commented on patch set 13 CR -1 04/16/20, 08:30

    ListWidget.rst:24 Unresolved

    Should we rather write something like '@Vendor\Ext\Widgets\Provider\TestListWidgetDataProvider' as this class does not exist?
  15. Daniel Siepmann uploaded patch set 14 04/16/20, 09:56

  16. TYPO3com voted on patch set 14 V +1 04/16/20, 10:11 Completed build in 15m 24s on Thu, 16 Apr, 10:11 AM Test Summary: 73559 passed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-2645

  17. Anja Leichsenring voted on patch set 14 V +1 CR +1 04/16/20, 16:54

  18. Richard Haeser commented on patch set 14 CR -1 04/16/20, 21:14

    Interfaces are changed. Will update this patch
  19. Richard Haeser uploaded patch set 15 04/16/20, 21:37

  20. Richard Haeser commented on patch set 15 04/16/20, 21:37

    Index.rst:79 Reply Unresolved

    You can only add one widget at the same time
  21. Richard Haeser voted on patch set 15 V +1 CR +1 04/16/20, 21:37

  22. TYPO3com voted on patch set 15 V +1 04/16/20, 21:48 Completed build in 11m 10s on Thu, 16 Apr, 09:48 PM Test Summary: 73561 passed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-2670

  23. Georg Ringer voted on patch set 15 V +1 CR +1 04/17/20, 04:50

  24. Susi Moog voted on patch set 15 V +2 CR +2 04/17/20, 07:40

  25. Susi Moog merged patch set 16 04/17/20, 07:40