sypets / brofix

Check for broken links, forked from TYPO3 system extension linkvalidator
Other
6 stars 8 forks source link

Vision for Linkvalidator + brofix #365

Open sypets opened 6 months ago

sypets commented 6 months ago

this is a work in progress, later move this to Wiki ...

open (bigger) issues / problems / questions

technical

  1. define scope: what is it, should it only check links or also references etc.?
  2. (check) external link checking does not scale: will result in excessive crawling of external sites, esp. if the sum of all linkvalidator / brofix installations are considered - how to deal with this?
  3. (check) external link checking: false positives
  4. long term maintenance: should brofix and linkvalidator be 2 separate extensions, this divides available resources, ideally should share common code
  5. (ui) link report is sluggish because entire page tree is crawled on every load
  6. (ui|check) link check results possibly not up to date, because
    • link target might have changed status
    • link source: link no longer in field or element is not visible or deleted
  7. (ui) link report not well usable
  8. (ui) multiple occurances of same link target must be edited (e.g. link targethttps://example.org/foobasel exists several times)

organizational, strategic

  1. address problem of long review wait time and contribution - how to get more people on board?
  2. how to coordinate development (linkvalidator)?
  3. where are core ideas / vision / specification for new features published and discussed?

solutions / ideas for the open issues (and beyond)

for 2: external link checking:

ideas:

there are several possible solutions for this which can be combined:

Ahrefs’ Broken Link Checker is powered by the largest live backlinks database in the industry.

https://ahrefs.com/broken-link-checker

already implemented:

Some of this is already implemented in brofix (URL cache, crawl delay), the exclude URL / domain button also contributes to reducing number of external URLs.

In linkvalidator, this is currently solved by deactivating external link checking by default (since v13).

Both brofix and linkvalidator point this problem out in the documentation.


for 3: false positives (external URLs):

ideas:

already implemented:

image

image


for 4: long term maintenance brofix/linkvalidator:

ideas:


for 5: link report sluggish / page tree:


for 7: link report not well usable:


for 8: multiple fixing of same link target:

(both probably out of scope but can be explored as separate extension)

_for 20: better coordination

Additional cool ideas

these are some ideas off top of my head, needs to be explored further, not all make sense

:smile:

Additional resources