Task #90503
closedSEO documentation improvements
100%
Description
Generally clean up what should be in EXT:seo docs and what should be in TYPO3 Explained, add missing and use same terms as in configuration.
Sort out what is documented in EXT:seo docs and what is in TYPO3 Explained¶
Some core configuration / features is documented in ext:seo and some ext:seo documentation is documented in "TYPO3 EXplained".
The indended state is:
- general TYPO3 stuff in TYPO3 explained with focus on development (but also configuration can be explained here, as in site handling)
- things that are system extension specific: ext:seo documentation
For more details, see https://forge.typo3.org/issues/90504
Document plugin.tx_seo in EXT:seo¶
see https://forge.typo3.org/issues/91939
Use the same terms in the text as in the configuration¶
I would use the same terms as in the "Site Configuration" module.
Example:
In the section Domains (in TypoScript settings) there is a warning:
Please ensure, that you have configured your sites so that they all have an entry point. This is used for generating the canonical tags, for example.
Warning
Please be aware that for SEO purposes it is best practise to use a fully qualified domain (for example: https://www.example.com). Therefor we don’t support the SEO enhancements in TYPO3 without a full domain. It might work, but it is not officially supported.
"use a fully qualified domain" where? I guess it is meant in the site configuration tab "General" "Entry Point" from the context, but the screenshot above does not use a FQDN, just /.
So I would
- update the screenshot to use a domain
- use the same terms in the text as in the configuration (and screenshot), e.g.:
- "General > Entry Point" (instead of "Domains")
- "Languages" instead of "Language"
- "Error Handling" instead of "Error pages"
"it is best practise to use a fully qualified domain for the :guilable:`Entry Point`