-
Notifications
You must be signed in to change notification settings - Fork 653
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[DOCS] Document known issues with ext:linkvalidator
Linkvalidator extension has a couple of known issues, especially with external link checking. Those issues are now documented, so integrators can acknowledge them and implement counter-measures. Resolves: #101597 Releases: main, 12.4, 11.5 Change-Id: I00dc01243426fc56c21a4bd11815c3009e3dd3ad Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/80364 Tested-by: core-ci <typo3@b13.com> Tested-by: Stefan B�rk <stefan@buerk.tech> Reviewed-by: Stefan B�rk <stefan@buerk.tech>
- Loading branch information
Showing
4 changed files
with
55 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
49 changes: 49 additions & 0 deletions
49
typo3/sysext/linkvalidator/Documentation/KnownProblems/Index.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
.. include:: /Includes.rst.txt | ||
|
||
.. _known-problems: | ||
|
||
============== | ||
Known problems | ||
============== | ||
|
||
|
||
.. _usagePitfallsExternalLinks: | ||
|
||
Problems with external links | ||
============================ | ||
|
||
The most relevant known problems currently concern "external broken links". | ||
|
||
Be polite when crawling external sites: They should not be checked too often. | ||
The extension currently provides no functionality to limit such requests. | ||
|
||
There are (at least) 2 possible counter-measures: | ||
|
||
#. Turn off external link checking entirely | ||
by removing `external` from Page TSconfig :ref:`linktypes` | ||
|
||
#. :ref:`Override the ExternalLinktype class <linktype-implementation>` | ||
(in your own extension), to check only specific URLs or exclude specific | ||
URLs or handle only specific error types as errors. | ||
|
||
|
||
.. _usagePitfallsFalsePositives: | ||
|
||
Falsely reported broken links | ||
============================= | ||
|
||
Linkvalidator may find false negatives when checking links. This can be | ||
annoying for editors since there is no way to declare them "ok" manually, | ||
they will be shown to editors over and over again. | ||
|
||
There are a couple of scenarios where linkvalidator may show a link as | ||
broken leading to a misleading result: | ||
|
||
* Automatic server-side external link checking may fail. There are many possible | ||
reasons for false negatives in this area like server connectivity issues or | ||
funny deny rules on the target system. | ||
* Sometimes links may not be broken as such, but are considered "broken" due to | ||
HTTP status like 4xx. | ||
* The broken link information may be "stale", the link has been checked a while ago | ||
and did lead to a negative result due to temporary a system outage or similar, is | ||
now working again, but has not been rechecked yet. |