TYPO3-Documentation / T3DocTeam

This repository is for the Documentation Team. To contribute, please see CONTRIBUTING.md For help and support on TYPO3, please see: https://typo3.org/help/
3 stars 1 forks source link

Define best practices for templating, unify, clean up and restructure existing docs #124

Closed sypets closed 2 years ago

sypets commented 4 years ago

Here is a relatively new Stack Overflow question which best illustrates the problem:

I'm learning Typo3 with the official documentation. Now I have achieved the Templating Tutorial: https://docs.typo3.org/m/typo3/tutorial-templating/9.5/en-us/MinimalDesign/Index.html There is described to store the HTML file under page.1.file = fileadmin/sitedesign/Resources/Private/Templates/Minimal.html So, let's start with the problems I have:

  1. The folder structure (beginning at sitedesign) does not exist.
  2. Under the link https://docs.typo3.org/m/typo3/reference-coreapi/9.5/en-us/ApiOverview/DirectoryStructure/Index.html is told that the fileadmin directory is used for editors and should not be used for HTML templates. This is in contradiction to the official documentation. Note this directory is meant for editors! Integrators should not locate frontend website layout related files in here: Storing HTML templates, logos, Css and similar files used to build the website layout in here is considered bad practice. Integrators should locate and ship these files within a project specific extension.
  3. So, where should I store HTML template files?

Additionally:


This also reflects a general problem in the documentation: Often new things are created, old things not removed or cleaned up, several solutions exist next to each other with no clear introduction showing the pros and cons and best practices. This is - of course - part of the problem that doing this really takes time and effort and is not so easy to do.

sypets commented 4 years ago

I would assume the "TYPO3 Integrator Certification" book covers the best practices

Additionally, there is a syllabus for certification.

So, what needs to be done is

sypets commented 2 years ago

What has been changed now is that if you are in the "Templating Tutorial" and switch to main branch, you are redirected to "Sitepackage Tutorial" - so that looks like there are no longer these 2 separate tutorials.

I am closing this now.