Review main Abandoned

62446[DOCS] Improve documentation in EXT:fluid_styled_content

Michael Telgkamp CR 0 V 0 Normal +60 −57 updated 12/15/19, 14:39

Commit message

Update the documentation of sysext fluid_styled_content
"Adding your own content elements".

* Use shorter sentences
* Remove/replace some unusual wordings
* Make sentences semantically in rst, to ease merge resolving.
* Use addTcaSelectItem instead of addPlugin, to add new CType to
  dropdown.

Review

  • Code review CR 0
  • Verified V 0

Issues 1

Files 1

Review log 2132

Show 57 earlier messages
  1. Michael Telgkamp uploaded patch set 1 11/28/19, 10:24

  2. TYPO3com voted on patch set 1 V +1 11/28/19, 10:36 Completed build in 11m 15s on Thu, 28 Nov, 10:36 AM Test Summary: 48375 passed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-38879

  3. Thomas W. voted on patch set 1 CR +1 11/28/19, 10:50

  4. Andreas Kienast updated the commit message in patch set 2 11/28/19, 11:01

  5. TYPO3com voted on patch set 2 V +1 11/28/19, 11:09 Completed build in 07m 56s on Thu, 28 Nov, 11:09 AM Test Summary: 48375 passed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-38881

  6. Thomas W. voted on patch set 2 V +1 CR +1 11/28/19, 11:25

  7. Daniel Siepmann commented on patch set 2 11/28/19, 13:42

    Index.rst:13

    I would like to break lines semantically. E.g. after comma or dots. That eases to solve merge conflicts in the future, as we have smaller chunks and defined contexts. Just like with Sourcecode where you have defined CGL which prevents different formats and unnecessary conflicts. Someone can adjust that paragraph, or I'll do once I find time.
  1. Michael Telgkamp uploaded patch set 3 11/28/19, 13:53

  2. Michael Telgkamp commented on patch set 3 11/28/19, 13:54

    Index.rst:13 Reply

    I added semantic linebreaks for all paragraphs in this document.
  3. TYPO3com voted on patch set 3 V -1 11/28/19, 14:01 Completed build in 08m 24s on Thu, 28 Nov, 02:01 PM Test Summary: 48128 passed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-38885

  4. TYPO3com voted on patch set 3 V +1 11/28/19, 15:18 Completed build in 1h 33m 07s on Thu, 28 Nov, 03:18 PM Test Summary: 48375 passed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-38885

  5. Daniel Siepmann uploaded patch set 4 11/29/19, 09:05

  6. Daniel Siepmann uploaded patch set 5 11/29/19, 09:07

  7. TYPO3com voted on patch set 4 V +1 11/29/19, 09:15 Completed build in 09m 19s on Fri, 29 Nov, 09:15 AM Test Summary: 48375 passed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-38916

  8. TYPO3com voted on patch set 5 V +1 11/29/19, 09:19 Completed build in 09m 33s on Fri, 29 Nov, 09:19 AM Test Summary: 48375 passed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-38917

  9. Michael Telgkamp commented on patch set 5 CR -1 11/29/19, 09:23

    Some more improvement suggestions

    Index.rst:73

    some lines above `your-icon-identifier` is used

    Index.rst:137

    "has to be placed at the path" instead of "have to be placed in the file"?

    Index.rst:138

    I do not get, what this sentence tells me. Did you mean "This file will load because it is registered as static file above."?

    Index.rst:140

    ..., paths for them need to be added.
  10. Michael Telgkamp wrote 11/29/19, 09:23

    Removed reviewer Thomas W..
  11. Daniel Siepmann uploaded patch set 6 11/29/19, 11:35

  12. Daniel Siepmann commented on patch set 6 11/29/19, 11:37

    Index.rst:73 Reply

    Done

    Index.rst:137 Reply

    Actually it is a file, not a path. So why should we switch to path here?

    Index.rst:138 Reply

    I've adjusted the sentences, please have another look.

    Index.rst:140 Reply

    Done
  13. TYPO3com voted on patch set 6 V +1 11/29/19, 12:25 Completed build in 54m 11s on Fri, 29 Nov, 12:25 PM Test Summary: 48375 passed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-38930

  14. Michael Telgkamp uploaded patch set 7 12/02/19, 08:09

  15. TYPO3com voted on patch set 7 V +1 12/02/19, 08:16 Completed build in 07m 01s on Mon, 2 Dec, 08:16 AM Test Summary: 48375 passed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-38989

  16. Daniel Siepmann uploaded patch set 8 12/03/19, 06:49

  17. TYPO3com voted on patch set 8 V -1 12/03/19, 06:56 Completed build in 07m 19s on Tue, 3 Dec, 06:56 AM Test Summary: 48301 passed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-39042

  18. TYPO3com commented on patch set 8 12/03/19, 07:35 Completed build in 08m 20s on Tue, 3 Dec, 07:35 AM Test Summary: 12 of 48719 failed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-39045

  19. TYPO3com voted on patch set 8 V +1 12/03/19, 13:10 Completed build in 07m 54s on Tue, 3 Dec, 01:10 PM Test Summary: 48367 passed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-39073

  20. Michael Telgkamp commented on patch set 8 V +1 CR +1 12/03/19, 13:40

    Index.rst:137 Reply

    I am happy with your change.

    Index.rst:138 Reply

    Done
  21. Sybille Peters commented on patch set 8 CR -1 12/06/19, 09:30

    While I like the changes, I think we might go even further and make some additional small improvements while we are at it. I will push another patch.

    Index.rst:36

    > Since this part is written for developers, it will not explain in full detail how an extension works. I would remove this paragraph.

    Index.rst:46

    comma: First,

    Index.rst:178

    This will load the Fluid template file :file:`NewContentElement.html`.

    Index.rst:186 Unresolved

    Suggestion ... you must create the Fluid template :file:`your_extension_key/Resources/Private/Templates/NewContentElement.html`.

    Index.rst:187 Unresolved

    > This template will be located at the directory and file name entered in :file:`setup.typoscript` using the parameter :typoscript:`templateName`. This has already been explained above. I would remove this.
  22. Lidia Demin commented on patch set 8 CR -1 12/10/19, 13:14

    The refactoring to a more objective description is good. Also, a lot of useful information was added. -1 is only because of the minor typo and I agree to the changes proposed by Sybille.

    Index.rst:25 Unresolved

    Would change it to "these" if you are changing "manipulation" to "manipulations"
  23. Sybille Peters commented on patch set 8 12/10/19, 13:48

    @Michael As discussed, I migrated the page to "TYPO3 Explained". You can find the new page in: https://docs.typo3.org/m/typo3/reference-coreapi/master/en-us/ApiOverview/ContentElements/AddingYourOwnContentElements.html The commit from this patch has not been applied yet. Next steps: 1) Continue work in "TYPO3 Explained" and create a PR there. 2) This patch can be abandoned 3) Sybille: Create new patch in fluid_styled_content docs to remove existing content "Adding your own content elements" and create redirect to "TYPO3 Explained" 4) Sybille: apply all for versions master, 9.5 and 8.7. Please contact me on Slack if there are any questions.

    Index.rst:36 Reply

    Done

    Index.rst:46 Reply

    Done

    Index.rst:178 Reply

    Done
  24. Sybille Peters commented on patch set 8 12/13/19, 16:48

    This patch can be abandoned. The page has been moved to "TYPO3 Explained". The changes from this patch were added as pull request: https://github.com/TYPO3-Documentation/TYPO3CMS-Reference-CoreApi/pull/691
  25. Daniel Goerz abandoned the change 12/15/19, 14:39

    What Sybille said