Review main Merged

72164[DOCS] Update outdated manual of EXT:fluid_styled_content

Lina Wolf CR +2 V +2 Expert +1228 −555 updated 01/18/22, 12:07

Commit message

Review

  • Code review CR +2 Done
    • Benni Mack +2
    • Susi Moog +1
  • Verified V +2 Done
    • Benni Mack +2
    • Susi Moog +1
    • core-ci +1 CI

Issues 1

Files 150

Show 130 more files

Review log 4365

Show 2540 earlier messages
  1. Lina Wolf uploaded patch set 1 11/13/21, 11:32

  2. core-ci voted on patch set 1 V +1 11/13/21, 11:52 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/19224

  3. Lina Wolf uploaded patch set 2 11/13/21, 17:57

  4. core-ci voted on patch set 2 V +1 11/13/21, 18:10 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/19229

  5. Lina Wolf uploaded patch set 3 11/13/21, 21:29

  6. core-ci voted on patch set 3 V +1 11/13/21, 21:45 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/19238

  7. Lina Wolf uploaded patch set 4 11/14/21, 11:47

  8. Lina Wolf updated the commit message in patch set 5 11/14/21, 11:47

  9. Lina Wolf uploaded patch set 6 11/14/21, 11:48

  10. Lina Wolf updated the commit message in patch set 7 11/14/21, 11:58

  11. Lina Wolf updated the commit message in patch set 8 11/14/21, 12:00

  12. core-ci voted on patch set 5 V +1 11/14/21, 12:05 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/19263

  13. Lina Wolf updated the commit message in patch set 9 11/14/21, 12:05

  14. core-ci voted on patch set 4 V +1 11/14/21, 12:09 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/19262

  15. core-ci voted on patch set 6 V +1 11/14/21, 12:09 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/19264

  16. core-ci voted on patch set 7 V -1 11/14/21, 12:15 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/19265

  17. core-ci voted on patch set 8 V +1 11/14/21, 12:17 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/19266

  18. core-ci voted on patch set 9 V +1 11/14/21, 12:24 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/19268

  19. Lina Wolf updated the commit message in patch set 10 11/14/21, 13:50

  20. Lina Wolf commented on patch set 10 11/14/21, 13:51

    I just found out that the introduction package doesn't use fluid_styled_content. So it doesn't really make sense to make the screenshots from there.
  21. core-ci voted on patch set 10 V +1 11/14/21, 14:05 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/19270

  22. Simon Gilli commented on patch set 10 11/15/21, 10:52

    Reply

    As far as I can see your screenshots are from the Backend where no FSC is involved...
  23. Simon Gilli commented on patch set 10 11/15/21, 14:51

    Reply

    imho it does not make much sense to include FE screenshots for FSC but ofc BE is very important to see the CE's in action in the BE.
  24. Lina Wolf uploaded patch set 11 11/24/21, 19:51

  25. Lina Wolf commented on patch set 11 11/24/21, 19:52

    Reply

    Done
    All Screenshots are now based on extension styleguide
  26. core-ci voted on patch set 11 V +1 11/24/21, 20:05 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/19713

  27. Tom Warwick uploaded patch set 12 11/25/21, 17:24

  28. core-ci voted on patch set 12 V +1 11/25/21, 17:48 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/19748

  29. Benni Mack commented on patch set 12 11/28/21, 20:48

    Should we keep the name "AutomaticScreenshot" as folder name?
  30. Lina Wolf commented on patch set 12 11/28/21, 20:52

    Reply

    We always keep the automatic screenshots in a separate folder, so the source can easily be seen. These shouldn't be overriden manually as the next run of the screenshots.json will override them. Also we might move the whole screenshots generation process to documentation rendering in the future.
  31. Benni Mack wrote 11/29/21, 10:21

    Change destination moved from master to main
  32. Benni Mack updated the commit message in patch set 13 11/29/21, 14:11

  33. core-ci voted on patch set 13 V +1 11/29/21, 18:46 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/20120

  34. Alexander Nitsche uploaded patch set 14 12/15/21, 12:17

  35. Alexander Nitsche commented on patch set 14 CR -1 12/15/21, 12:22

    1) Settings.cfg: "github_branch = master" results in 404 when editing the documentation page via the button "Edit on GitHub" (should be changed in all system extension documentations) 2) Settings.cfg: switch all intersphinx mappings from master to main branch 3) Settings.cfg: switch all intersphinx mappings to full URL, for example instead of - https://docs.typo3.org/typo3cms/InstallationGuide/ use - https://docs.typo3.org/m/typo3/guide-installation/main/en-us/ 4) Use auto-true copyright pattern "since <year>" instead of "<creation-year> to <current-year>" 5) Index.rst: Align description to description of Settings.cfg 6) remove dummy texts 7) Index.rst: Insert input/output example to get first impression: Screenshot of backend form of content element with inserted values and output in frontend (maybe enriched with showing underlying Fluid template). 8) Index.rst: Remove support section which is already handled by the Settings.cfg. no system extension has such support section. 9) Installation/Index.rst: I would remove the manual screenshot here, as it provides no additional value (the complete installation procedure is already documented well in the linked official TYPO3 documentation) but adds maintenance costs 10) FirstSteps/Index.rst: add introduction text to guide the reader 11) Configuration/Index.rst: use italic style to emphasize terms - instead of using quotes 12) Use term "site package" consequently 13) OverridingFluidTemplates/Index.rst: the last paragraph leaves the reader in uncertain state: the templateName can be changed, but it ends in something failing: why should it be done? how to solve the issue? 14) TypoScript/Index.rst: instead of using a manual screenshot i would use a code block to describe file structures, like e.g. in https://docs.typo3.org/m/typo3/tutorial-getting-started/11.5/en-us/Installation/Install.html#execute-composer-create-project. reduces maintenance costs, can be reduced to the minimum files and folders required for explanation and is searchable. 15) TypoScript/Index.rst: a section mentions the '"Setup" folder in the same directory. More about these files later.': i cannot find the Setup folder and cannot find any explanation later. 16) Use term "content element" (lowercased) 17) AddingYourOwnContentElements/Index.rst: the whole topic is claimed to be contained in this documentation on the introduction page. i would redirect the reader on the introduction page to the explained page directly, if s:he looks for this topic. and i would either remove this page completely, or remove the hints of < 8.x (which should be in the regarding documentation of EXT:fluid_styled_content:7) and transform the attention hint to a normal text.
  36. core-ci voted on patch set 14 V +1 12/15/21, 12:29 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/21123

  37. Lina Wolf rebased onto patch set 15 12/15/21, 17:26

  38. core-ci voted on patch set 15 V +1 12/15/21, 17:37 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/21141

  39. Lina Wolf uploaded patch set 16 12/17/21, 11:08

  1. Lina Wolf uploaded patch set 17 12/17/21, 11:14

  2. Lina Wolf updated the commit message in patch set 18 12/17/21, 11:19

  3. Lina Wolf commented on patch set 18 12/17/21, 11:19

    Reply

    1) done, this change wasn't rebased yet after the master-main change 2) done, this change wasn't rebased yet after the master-main change 3) Removed non-used references. all others have been pointing to main anyway after the rebase 4) this came automatically with the rebase 5) done 6) didnt find any, where did you see dummy texts? 7) can be done in a separate change 8) What support section? didnt find any 9) done 10) can be done in a separate change 11) already uses italic, so I prefere more semantic usages, what do you mean exactly? 12) where is it used with another term? didnt find any 13) removed it, I see no real reason why you would want to do it that way? 14) done 15) done 16) done 17) orphaned the page and included the link TYPO3 explained in the menu
  4. core-ci voted on patch set 16 V +1 12/17/21, 11:21 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/21202

  5. core-ci voted on patch set 17 V +1 12/17/21, 11:31 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/21205

  6. core-ci voted on patch set 18 V +1 12/17/21, 11:36 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/21206

  7. Alexander Nitsche uploaded patch set 19 12/17/21, 19:12

  8. Alexander Nitsche commented on patch set 19 12/17/21, 19:14

    Reply

    > 6) didnt find any, where did you see dummy texts? The hint of the sitemap was the last remain, did remove it. if you still want to link to the sitemap, would add it to the main menu. > 7) can be done in a separate change Would do it now, it is really missing. > 8) What support section? didnt find any Removed it already. > 11) already uses italic, so I prefere more semantic usages, what do you mean exactly? Adapted some more quoted terms. 12) where is it used with another term? didnt find any Adapted it already.
  9. core-ci voted on patch set 19 V +1 12/17/21, 19:25 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/21221

  10. Lina Wolf commented on patch set 19 12/18/21, 08:23

    Reply

    7) The thing is we don't have a Suite yet which shows the output of fluid_styled_content. EXT:introduction does not use fluid_styled_content even though it uses similar techniques. So we could add a manual Screenshot or do a quite complex step by step production of contents as I have done for the site_package tutorial. I want to do neither right now and would prefere to postphone adding more screenshots to the Introduction / What does it do section
  11. Alexander Nitsche commented on patch set 19 12/18/21, 10:15

    Reply

    Ok.
  12. Susi Moog commented on patch set 19 01/05/22, 08:58

    Index.rst:12

    should this use guilabel?

    Index.rst:64

    "Show in Section Menus" (-s in Section"s")

    DefaultTemplate.rst:45

    should we add how to include these file based, too? because we point to the site package tutorial in other parts of these docs, it may make sense to give the reader a copy-paste "@import EXT:..." line here for the default templates.
  13. Susi Moog commented on patch set 19 01/05/22, 10:28

    Index.rst:23

    The headline states "text & images" - in the text & images element the tab is called "Images"
  14. Lina Wolf uploaded patch set 20 01/06/22, 10:53

  15. core-ci voted on patch set 20 V +1 01/06/22, 11:05 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/21687

  16. Lina Wolf uploaded patch set 21 01/06/22, 11:13

  17. Lina Wolf commented on patch set 21 01/06/22, 11:14

    Index.rst:12 Reply

    Done

    Index.rst:64 Reply

    Done

    Index.rst:23 Reply

    Done

    DefaultTemplate.rst:45 Reply

    Done
  18. core-ci voted on patch set 21 V +1 01/06/22, 11:24 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/21688

  19. Alexander Nitsche commented on patch set 21 01/06/22, 12:16

    Index.rst:58

    In addition to the Fluid template markup i would add the generated HTML output - before showing the rendered image.
  20. Lina Wolf uploaded patch set 22 01/17/22, 18:25

  21. Lina Wolf commented on patch set 22 01/17/22, 18:26

    Index.rst:58 Reply

    Done
  22. core-ci voted on patch set 22 V +1 01/17/22, 18:40 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/22192

  23. Susi Moog voted on patch set 22 V +1 CR +1 01/18/22, 10:13

  24. Benni Mack voted on patch set 22 V +2 CR +2 01/18/22, 11:51

  25. Lina Wolf merged patch set 23 01/18/22, 12:07