#90503SEO documentation improvements
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`
Reviews 2
Related issues 2
History 915
-
Georg Ringer changed status
NewAccepted <span data-processor="relativetime" data-value="2020-03-05T14:34:37+00:00" > 03/05/20, 14:34 </span> -
Sybille Peters changed assigned to Sybille Peters <span data-processor="relativetime" data-value="2022-11-09T08:05:52+00:00" > 11/09/22, 08:05 </span>
-
Garvin Hicking commented and changed assigned to Garvin Hicking <span data-processor="relativetime" data-value="2024-06-07T09:05:25+00:00" > 06/07/24, 09:05 </span>
-
Sybille Peters commented <span data-processor="relativetime" data-value="2024-06-07T09:32:12+00:00" > 06/07/24, 09:32 </span>
ok. Let me know if you would like feedback from me.
-
Gerrit Code Review pushed patch set 1 for main to change 84618 status
AcceptedUnder Review <span data-processor="relativetime" data-value="2024-06-11T14:52:50+00:00" > 06/11/24, 14:52 </span> -
Garvin Hicking changed Related to #90504 <span data-processor="relativetime" data-value="2024-06-11T15:59:00+00:00" > 06/11/24, 15:59 </span>
-
Garvin Hicking changed Related to #91939 <span data-processor="relativetime" data-value="2024-06-11T16:07:06+00:00" > 06/11/24, 16:07 </span>
-
Sybille Peters changed subject
SEO documentation: site configurationSEO documentation improvements description <span data-processor="relativetime" data-value="2024-06-12T03:59:23+00:00" > 06/12/24, 03:59 </span> -
Gerrit Code Review pushed patch set 2 for main to change 84618 <span data-processor="relativetime" data-value="2024-06-14T06:32:59+00:00" > 06/14/24, 06:32 </span>
-
Gerrit Code Review pushed patch set 3 for main to change 84618 <span data-processor="relativetime" data-value="2024-07-12T08:44:42+00:00" > 07/12/24, 08:44 </span>
-
Gerrit Code Review pushed patch set 1 for 12.4 to change 85240 <span data-processor="relativetime" data-value="2024-07-12T09:57:44+00:00" > 07/12/24, 09:57 </span>
-
Gerrit Code Review pushed patch set 4 for main to change 84618 <span data-processor="relativetime" data-value="2024-07-12T11:15:20+00:00" > 07/12/24, 11:15 </span>
-
Gerrit Code Review pushed patch set 2 for 12.4 to change 85240 <span data-processor="relativetime" data-value="2024-07-12T11:17:07+00:00" > 07/12/24, 11:17 </span>
-
Garvin Hicking commented and changed status
Under ReviewResolved done0 %100 % <span data-processor="relativetime" data-value="2024-07-12T12:15:08+00:00" > 07/12/24, 12:15 </span>Applied in changeset commit:1c4c76647878b19bed348c7fc31a6aeddd1fe301.
-
Benni Mack changed status
ResolvedClosed <span data-processor="relativetime" data-value="2024-10-15T09:30:26+00:00" > 10/15/24, 09:30 </span>
Can work on this. I’m out for screenshot regeneration however. ;-)