Task #90504
Updated by Sybille Peters over 2 years ago
I think the seo documentation is already in a pretty good state but when trying to add documentation for new features I noticed that 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":https://docs.typo3.org/m/typo3/reference-coreapi/master/en-us/ApiOverview/Seo/Index.html 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":https://docs.typo3.org/c/typo3/cms-seo/master/en-us/ ext:seo documentation h2. Examples *sitemap*: For the XmlSitemap: That is actually a general TYPO3 feature, so it should exist in "TYPO3 Explained" and does but the implementation and specific configuration (TS: "plugin.tx_seo.config.xmlSitemap":https://docs.typo3.org/m/typo3/reference-coreapi/master/en-us/ApiOverview/XmlSitemap/Index.html#xmlsitemapdataproviders) is ext:seo specific. Also XML sitemaps are not mentioned _at all_ in ext:seo documentation. *TypoScript* ext:seo documentation contains a list of _general_ TYPO3 TypoScript but _no ext:seo specific_ TypoScript (e.g. the XmlSitemap). I have not checked everything yet ... h2. General consideration This separation into system documentation, "TYPO3 Explained" etc. is a little unfortunate and not so easy to solve. We try to avoid duplicate content and have been doing a lot to wipe it out but in some cases it would help to add the content in both places: but you should define where it is mainly documented and the other place should only contain the bare basics and have a link to the main content. *Very* strictly separating the content and only adding links is good for removing duplicates but does not make for a good reading experience, IMHO. So make sure it is well readable without having a lot of dependencies that are documented elsewhere. h2. Resources This is the existing documentation: System extension: * "ext:seo":https://docs.typo3.org/c/typo3/cms-seo/master/en-us/Index.html "TYPO3 Explained" * "SEO":https://docs.typo3.org/m/typo3/reference-coreapi/master/en-us/ApiOverview/Seo/Index.html * "XML Sitemap": https://docs.typo3.org/m/typo3/reference-coreapi/master/en-us/ApiOverview/XmlSitemap/Index.html * "MetaTag API":https://docs.typo3.org/m/typo3/reference-coreapi/master/en-us/ApiOverview/MetaTagApi/Index.html * "PageTitle API":https://docs.typo3.org/m/typo3/reference-coreapi/master/en-us/ApiOverview/PageTitleApi/Index.html TypoScript reference * various places, see for example overview of config settings in "ext:seo":https://docs.typo3.org/c/typo3/cms-seo/master/en-us/Configuration/Index.html#typoscript-settings