Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove superfluous asterisk pattern #288

Closed
wants to merge 1 commit into from

Conversation

franzholz
Copy link
Contributor

The TYPO3 docs example code should not contain superfluous unnecessary things like the asterisk in the Glob Pattern for the file Services.yaml.
I have also made a patch for the testing of the TYPO3 Core without this asterisk. It seems that the former developer did not know that only the folders have to be configured and not the files.
I have tested the TYPO3 Core 13 with this fix and did not find any new error.

@franzholz
Copy link
Contributor Author

Patch file for TYPO3 13.2.1
services-without-asterisk.diff.txt

@garvinhicking
Copy link
Contributor

Closing this ticket as discussed in the other one. Feel free to provide a patch for this to the TYPO3 core - if it gets changed there, we can very well align our documentation to that. Thanks for your contribution.

@franzholz
Copy link
Contributor Author

franzholz commented Aug 30, 2024

This is meant for the TYPO3 Documentation.
Do not force a patch into the TYPO3 Core in order to get something documented!

Besides, this has not been discussed.

@linawolf
Copy link
Member

I can see how this topic is highly oppininated, however the Documentation Team will follow the lead of the Core Team here.

@franzholz
Copy link
Contributor Author

franzholz commented Aug 31, 2024

How should normal TYPO3 users understand this? Even Garvin Hicking got it wrong in the beginning. I think that this asterisk is the reason for leading readers into the wrong direction. I am sure I am not the only one who misunderstood it only because of this wrong example and documentation. Yes, it works, but it also works without the asterisk. So why do you refuse to make it clear in the documentation? There should be no force to stick to the PHP code of the TYPO3 Core when this makes no sense. The documentation is only helpful if even unexperienced developers can understand it.

@linawolf
Copy link
Member

linawolf commented Aug 31, 2024

Thank you for sharing your perspective, Franz I appreciate your attention to detail and your concern for making the documentation clear and accessible.

To clarify, while developers have the flexibility to use different patterns in their Services.yaml files for TYPO3 Extension development, our goal in the documentation is to provide examples that are closely aligned with what the TYPO3 Core uses. This approach helps ensure consistency and familiarity for developers who work both with Core and extensions, reducing potential confusion.

The asterisk in question is an example of this alignment. We understand that it might not be strictly necessary in all cases, but including it in our examples reflects a pattern that is widely used and recommended within the Core. This consistency can help both new and experienced developers maintain a coherent approach across different projects.

If you feel that this example is misleading or could be improved, we’re open to discussing how we can make the documentation clearer while still adhering to this principle. We aim to strike a balance between flexibility and guidance, ensuring that the documentation is both accurate and helpful.

Thank you again for your contributions and for helping us improve the TYPO3 ecosystem.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants