Review main Merged

63324[FEATURE] Dashboard widget: documentation TSconfig Reference

Koen Wouters CR +2 V +2 Normal +51 −0 updated 02/20/20, 21:54

Commit message

A TSconfig Reference documentation widget is added.

Review

  • Code review CR +2 Done
    • Richard Haeser +2
    • Daniel Siepmann +1
  • Verified V +2 Done
    • Richard Haeser +2
    • Daniel Siepmann +1
    • TYPO3com +1 CI

Issues 1

Files 4

Review log 1213

  1. Koen Wouters uploaded patch set 1 02/19/20, 18:08

  2. TYPO3com voted on patch set 1 V +1 02/19/20, 18:31 Completed build in 21m 26s on Wed, 19 Feb, 06:31 PM Test Summary: 71464 passed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-320

  3. Björn Jacob voted on patch set 1 CR +1 02/19/20, 18:42

  4. Markus Klein commented on patch set 1 CR -1 02/19/20, 18:54

    I'm actually against bringing in such dev-related widget to the core. IMO the dashboard shall be for the casual editor. I think those documentation link-widget live better in an extra extension, especially those can be maintained easier if anything in the documentation infrastructure changes.
  5. Daniel Siepmann commented on patch set 1 02/19/20, 18:57

    > Patch Set 1: Code-Review-1 > > I'm actually against bringing in such dev-related widget to the core. > IMO the dashboard shall be for the casual editor. > I think those documentation link-widget live better in an extra extension, especially those can be maintained easier if anything in the documentation infrastructure changes. I'm ok with such widgets. I would like to have a separate Tab, if we would add Widgets for all official references / Manuals. As I would not expects editors to add such widgets. Also one would hide those widgets, or keep "Getting started" for them. Especially if this would be the first module one sees after a fresh installation, a default Dashboard with those widgets might be helpful?

    DocumentationTSconfigReferenceWidget.php:28 Unresolved

    Would be cool if we could use the matching version. E.g. use https://github.com/TYPO3/TYPO3.CMS/blob/master/typo3/sysext/core/Classes/Information/Typo3Version.php#L43 to build the expected url? That way users receive the documentation matching their TYPO3 version. Right now that would be master of course. Not sure how to handle that. Maybe check for non released version or something like that? There is no docs for 10 until the LTS release. Example urls: https://docs.typo3.org/m/typo3/reference-tsconfig/9.5/en-us/Index.html https://docs.typo3.org/m/typo3/reference-tsconfig/8.7/en-us/Index.html There is always one url for each LTS branch. So should be easy, except the master state.
  6. Richard Haeser commented on patch set 1 CR -1 02/19/20, 19:05

    > Patch Set 1: Code-Review-1 > > I'm actually against bringing in such dev-related widget to the core. > IMO the dashboard shall be for the casual editor. > I think those documentation link-widget live better in an extra extension, especially those can be maintained easier if anything in the documentation infrastructure changes. The dashboard is definitely not only for editors but for all backend users. As a system maintainer I would like to get more technical information. This kind of widgets are for sure not the most used widgets. But as this was a request of Benni to have links to 3 docs (Getting started, TSref and TSconfig) we easily duplicated the getting started docs. As Daniel mentioned, maybe we can introduce a Documentation widget group? And we should check the current version indeed.
  7. Markus Klein commented on patch set 1 CR 0 02/19/20, 19:10

    Fair enough then.
  8. Koen Wouters marked it work in progress 02/19/20, 19:41

  9. Björn Jacob commented on patch set 1 CR 0 02/19/20, 21:23

    Thank you guys for your input. Would love to see a documentation group.
  10. Koen Wouters commented on patch set 1 02/20/20, 21:33

    I have made two separate tasks in forge for the automatic links to version related documentation and the documentation group. - Documentation group: https://forge.typo3.org/issues/90457 - Automatic links: https://forge.typo3.org/issues/90456
  11. Daniel Siepmann voted on patch set 1 V +1 CR +1 02/20/20, 21:40

  12. Richard Haeser voted on patch set 1 V +2 CR +2 02/20/20, 21:54

  13. Richard Haeser merged patch set 2 02/20/20, 21:54