Review main Merged

63323[FEATURE] Dashboard widget: documentation TypoScript Reference

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

Commit message

A TypoScript Reference documentation widget is added.

Review

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

Issues 1

Files 4

Review log 1520

  1. Koen Wouters uploaded patch set 1 02/19/20, 17:50

  2. TYPO3com voted on patch set 1 V -1 02/19/20, 18:03 Completed build in 12m 49s on Wed, 19 Feb, 06:03 PM Test Summary: 61313 passed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-317

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

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

  5. Daniel Siepmann commented on patch set 1 02/19/20, 18:56

    DocumentationTypoScriptReference.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.

    locallang.xlf:96 Unresolved

    To keep the same name, I would suggest "TypoScript Template Reference" instead. That was adjusted in order to distinguish between TypoScript Syntax, and TypoScript for TSconfig and TypoScript for Template Records.
  6. Koen Wouters uploaded patch set 2 02/19/20, 19:37

  7. Koen Wouters commented on patch set 2 02/19/20, 19:39

    Added WIP status for this review. Get branch works, but gives 10.3 as result. This results in an 404 for the link to the documentation
  8. Daniel Siepmann commented on patch set 2 02/19/20, 19:47

    > Patch Set 2: > > Added WIP status for this review. Get branch works, but gives 10.3 as result. This results in an 404 for the link to the documentation That's what I meant with: > There is always one url for each LTS branch. So should be easy, except the master state. I've no good idea how to handle the master case. I've some ideas but would not consider them to be good. We could introduce the widget and adjust it later if we have a better idea. That would be an improvement in user experience to get the documentation for current TYPO3 version, but no must have I guess :)
  9. TYPO3com voted on patch set 2 V -1 02/19/20, 19:52 Completed build in 14m 49s on Wed, 19 Feb, 07:52 PM Test Summary: 71354 passed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-325

  10. Koen Wouters commented on patch set 3 02/20/20, 21:20

    Published edit on patch set 2.
  11. Daniel Siepmann voted on patch set 3 V +1 CR +1 02/20/20, 21:25

  12. Koen Wouters commented on patch set 3 02/20/20, 21:28

    Add separate task in forge for the automatic documentation links, since there is no easy fix now. https://forge.typo3.org/issues/90456
  13. TYPO3com voted on patch set 3 V +1 02/20/20, 22:40 Completed build in 36m 52s on Thu, 20 Feb, 10:40 PM Test Summary: 71464 passed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-367

  14. Koen Wouters uploaded patch set 4 02/21/20, 08:05

  15. TYPO3com voted on patch set 4 V +1 02/21/20, 08:37 Completed build in 22m 45s on Fri, 21 Feb, 08:37 AM Test Summary: 71464 passed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-383

  16. Riny van Tiggelen voted on patch set 4 CR +1 02/21/20, 08:44

  17. Richard Haeser voted on patch set 4 V +1 CR +1 02/21/20, 09:10

  18. Daniel Siepmann voted on patch set 4 V +1 CR +1 02/21/20, 11:36

  19. Richard Haeser voted on patch set 4 V +2 CR +2 02/21/20, 11:55

  20. Richard Haeser merged patch set 5 02/21/20, 11:55