TYPO3CMS-Reference-CoreApi icon indicating copy to clipboard operation
TYPO3CMS-Reference-CoreApi copied to clipboard

Diagram of TYPO3 overview in Introduction - questions / suggestions

Open sypets opened this issue 3 years ago • 1 comments

I believe, a new diagram was introduced with #1336, https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/_images/Typo3CmsStructure.png @flicstar @linawolf

While I like the diagram in general, I do have some comments about it. Probably best to get some feedback before creating a PR.

Questions

  • The diagram is png. Can we do the diagram text-based or in a way that you can access and edit the source directly (e.g. as SVG or plantUML or something else). Diagram as text better maintainable.
  • Is it a good idea to list the filesystems? (NTFS|ext4|ReiserFS) - I am pretty sure TYPO3 should work with some other filesystems as well. This makes it look like a limit and that other filesystems are not supported.
  • Why the acronyms IaaS, PaaS etc ("Infrastructure as a service", "Platform as a service"). From my understanding this refers to using something provided remotely as a service, usually as a cloud service. Is this correct in this context? It is possible to host TYPO3 yourself. This also looks like a limitation which would not be correct (but just one of many options), but I may not have understood the intention.
  • why DDD under Application Wiring ("domain driven design")?
  • why is "Install Tool", "Website Back-End", "Website Font-End" on top of "Command Line Interface". Generally I would assume this diagram is structured as a conceptional layer model (like the OSI model).

Suggestions

  • can be derived from the questions once they are clarified.
  • add explanation of the parts - where not obvious
  • typo: "Costomization", I believe should be "Customization"

sypets avatar Apr 23 '22 10:04 sypets

Thanks for your feedback @sypets. All good points. This diagram is from the TYPO3 Guidebook which might explain why it is the way it is.

  • I agree, we should try to recreate this as SVG or plantUML. Anyone we know got expertise for that? I can try but it would be my first time. I've always wanted to try plantUML.
  • I think we can lose the IaaS and PaaS acronyms.
  • I think the DDD is from context of the book.

We could finesse the layout and address typos (!!) in our recreation of the diagram.

flicstar avatar Apr 24 '22 00:04 flicstar

No action since many years.

Alagts avatar Feb 09 '25 10:02 Alagts