Link Checker Report about napari.github.io

[GenevieveBuckley]

There are a lot of broken links caused by files that have been renamed or moved. I'm tempted to just let @melissawm re-organise everything first, before we go through and fix all the links one by one napari/napari#3390

[melissawm]

Yes - I'm actually going through some of the files and fixing those as I go, trying to get the sphinx errors and warnings down :)

[GenevieveBuckley]

Well, I guess this answers our question! No, the link checker is not set up correctly.

There's a few different things going on here:

1. Links with relative paths are producing the error Cannot find file file:///github/workspace/tutorials/.... This should be easy to fix, by setting --base https://napari.org
2. Too many requests to Github pages: HTTP status client error (429 Too Many Requests) for url (https://github.com/.... The solution here should be adding our github token as an argument to the lychee call --github-token <github-token>
3. Some links should not be checked (eg: http://localhost:8080/ is a localhost address, actions/[email protected] is not a link, and https://github.com/orgs/napari/teams/core-devs is not accessible to anyone outside the core dev team). There are some --exclude options for lychee that we should be able to use to fix this.
4. Forbidden pages. Anytime lychee tries to check links to https://forum.image.sc it receives a forbidden page error. I'm not sure why - I can open these links just fine in an incognito window (so the problem can't be that you need to be logged in to an account to see the pages). This needs more investigation.
5. Actually broken links. Some of these links are actually broken, mostly because pages were rearranged. This means we'll need to be diligent about checking links when the major docs reorganization happens soon.

[GenevieveBuckley]

Summarizing:

Broken links that need fixing (due to file renaming, etc.):

Errors in developers/contributing.md
✗ https://napari.org/TESTING.md (HTTP status client error (404 Not Found) for url (https://napari.org/TESTING.md))
✗ https://napari.org/guides/translations.md (HTTP status client error (404 Not Found) for url (https://napari.org/guides/translations.md))
✗ https://napari.org/CODE_OF_CONDUCT.md (HTTP status client error (404 Not Found) for url (https://napari.org/CODE_OF_CONDUCT.md))

Errors in developers/profiling.md
✗ https://napari.org/images/execution_graph.png (HTTP status client error (404 Not Found) for url (https://napari.org/images/execution_graph.png))

Errors in roadmaps/0_4.md
✗ https://napari.org/CONTRIBUTING.md (HTTP status client error (404 Not Found) for url (https://napari.org/CONTRIBUTING.md))
✗ https://napari.org/MISSION_AND_VALUES.md#our-mission (HTTP status client error (404 Not Found) for url (https://napari.org/MISSION_AND_VALUES.md#our-mission))
✗ https://napari.org/MISSION_AND_VALUES.md#our-values (HTTP status client error (404 Not Found) for url (https://napari.org/MISSION_AND_VALUES.md#our-values))
✗ https://napari.org/GOVERNANCE.md (HTTP status client error (404 Not Found) for url (https://napari.org/GOVERNANCE.md))
✗ https://napari.org/MISSION_AND_VALUES.md (HTTP status client error (404 Not Found) for url (https://napari.org/MISSION_AND_VALUES.md))

Errors in developers/testing.md
✗ https://napari.org/images/tests.png (HTTP status client error (404 Not Found) for url (https://napari.org/images/tests.png))

Errors in community/mission_and_values.md
✗ https://napari.org/CODE_OF_CONDUCT.md (HTTP status client error (404 Not Found) for url (https://napari.org/CODE_OF_CONDUCT.md))
✗ https://napari.org/GOVERNANCE (HTTP status client error (404 Not Found) for url (https://napari.org/GOVERNANCE))
✗ https://napari.org/CORE_DEV_GUIDE.md (HTTP status client error (404 Not Found) for url (https://napari.org/CORE_DEV_GUIDE.md))

Errors in roadmaps/0_3.md
✗ https://napari.org/CONTRIBUTING.md (HTTP status client error (404 Not Found) for url (https://napari.org/CONTRIBUTING.md))
✗ https://napari.org/MISSION_AND_VALUES.md#our-values (HTTP status client error (404 Not Found) for url (https://napari.org/MISSION_AND_VALUES.md#our-values))
✗ https://napari.org/GOVERNANCE.md (HTTP status client error (404 Not Found) for url (https://napari.org/GOVERNANCE.md))
✗ https://napari.org/MISSION_AND_VALUES.md#our-mission (HTTP status client error (404 Not Found) for url (https://napari.org/MISSION_AND_VALUES.md#our-mission))
✗ https://napari.org/MISSION_AND_VALUES.md (HTTP status client error (404 Not Found) for url (https://napari.org/MISSION_AND_VALUES.md))

Errors in roadmaps/0_3_retrospective.md
✗ https://napari.org/GOVERNANCE.md (HTTP status client error (404 Not Found) for url (https://napari.org/GOVERNANCE.md))
✗ https://napari.org/MISSION_AND_VALUES.md#our-mission (HTTP status client error (404 Not Found) for url (https://napari.org/MISSION_AND_VALUES.md#our-mission))
✗ https://napari.org/CONTRIBUTING.md (HTTP status client error (404 Not Found) for url (https://napari.org/CONTRIBUTING.md))
✗ https://napari.org/ROADMAP_0_4.md (HTTP status client error (404 Not Found) for url (https://napari.org/ROADMAP_0_4.md))
✗ https://napari.org/MISSION_AND_VALUES.md#our-values (HTTP status client error (404 Not Found) for url (https://napari.org/MISSION_AND_VALUES.md#our-values))
✗ https://napari.org/MISSION_AND_VALUES.md (HTTP status client error (404 Not Found) for url (https://napari.org/MISSION_AND_VALUES.md))

Errors in tutorials/index.md
✗ https://napari.org/fundamentals/getting_started (HTTP status client error (404 Not Found) for url (https://napari.org/fundamentals/getting_started))
✗ https://napari.org/fundamentals/installation (HTTP status client error (404 Not Found) for url (https://napari.org/fundamentals/installation))
✗ https://napari.org/gallery (HTTP status client error (404 Not Found) for url (https://napari.org/gallery))

Errors in community/governance.md
✗ https://napari.org/CORE_DEV_GUIDE.md (HTTP status client error (404 Not Found) for url (https://napari.org/CORE_DEV_GUIDE.md))
✗ https://napari.org/CONTRIBUTING.md (HTTP status client error (404 Not Found) for url (https://napari.org/CONTRIBUTING.md))
✗ https://napari.org/MISSION_AND_VALUES.md (HTTP status client error (404 Not Found) for url (https://napari.org/MISSION_AND_VALUES.md))

Errors in release/release_0_3_0.md
✗ https://napari.org/docs/developers/ROADMAP_0_3.html (HTTP status client error (404 Not Found) for url (https://napari.org/docs/developers/ROADMAP_0_3.html))

Errors in developers/core_dev_guide.md
✗ https://napari.org/CONTRIBUTING.md (HTTP status client error (404 Not Found) for url (https://napari.org/CONTRIBUTING.md))
✗ https://napari.org/MISSION_AND_VALUES.md (HTTP status client error (404 Not Found) for url (https://napari.org/MISSION_AND_VALUES.md))
✗ https://napari.org/BENCHMARKS.md (HTTP status client error (404 Not Found) for url (https://napari.org/BENCHMARKS.md))
✗ https://napari.org/GOVERNANCE.md (HTTP status client error (404 Not Found) for url (https://napari.org/GOVERNANCE.md))
✗ https://napari.org/CODE_OF_CONDUCT.md (HTTP status client error (404 Not Found) for url (https://napari.org/CODE_OF_CONDUCT.md))

Errors in _templates/page.html
✗ https://napari.org/%7B%7B%20pathto('_sources',%201)%20%7D%7D/%7B%7B%20ipynb_source%20%7D%7D (HTTP status client error (404 Not Found) for url (https://napari.org/%7B%7B%20pathto('_sources',%201)%20%7D%7D/%7B%7B%20ipynb_source%20%7D%7D))
(base) genevieve@genevieve-G5-5500:~/GitHub/napari.github.io$ 

Too many requests too quickly for github pages:

Errors in community/team.md
✗ https://github.com/kevinyamauchi (HTTP status client error (429 Too Many Requests) for url (https://github.com/kevinyamauchi))
✗ https://github.com/AhmetCanSolak (HTTP status client error (429 Too Many Requests) for url (https://github.com/AhmetCanSolak))
✗ https://github.com/kne42 (HTTP status client error (429 Too Many Requests) for url (https://github.com/kne42))
✗ https://github.com/shanaxel42 (HTTP status client error (429 Too Many Requests) for url (https://github.com/shanaxel42))
✗ https://github.com/GenevieveBuckley (HTTP status client error (429 Too Many Requests) for url (https://github.com/GenevieveBuckley))
✗ https://github.com/justinelarsen (HTTP status client error (429 Too Many Requests) for url (https://github.com/justinelarsen))
✗ https://github.com/royerloic (HTTP status client error (429 Too Many Requests) for url (https://github.com/royerloic))
✗ https://github.com/tlambert03 (HTTP status client error (429 Too Many Requests) for url (https://github.com/tlambert03))
✗ https://github.com/ziyangczi (HTTP status client error (429 Too Many Requests) for url (https://github.com/ziyangczi))

Errors in community/governance.md
✗ https://github.com/sofroniewn (HTTP status client error (429 Too Many Requests) for url (https://github.com/sofroniewn))
✗ https://github.com/jni (HTTP status client error (429 Too Many Requests) for url (https://github.com/jni))
✗ https://github.com/napari (HTTP status client error (429 Too Many Requests) for url (https://github.com/napari))
✗ https://github.com/royerloic (HTTP status client error (429 Too Many Requests) for url (https://github.com/royerloic))

Errors in community/code_of_conduct.md
✗ https://github.com/sofroniewn (HTTP status client error (429 Too Many Requests) for url (https://github.com/sofroniewn))
✗ https://github.com/csweaver (HTTP status client error (429 Too Many Requests) for url (https://github.com/csweaver))
✗ https://github.com/jni (HTTP status client error (429 Too Many Requests) for url (https://github.com/jni))
✗ https://github.com/kne42 (HTTP status client error (429 Too Many Requests) for url (https://github.com/kne42))

403 Forbidden error for image.sc links:

Errors in tutorials/index.md
✗ https://forum.image.sc/tags/napari (HTTP status client error (403 Forbidden) for url (https://forum.image.sc/tags/napari))

Errors in community/governance.md
✗ https://forum.image.sc/tags/napari (HTTP status client error (403 Forbidden) for url (https://forum.image.sc/tags/napari))

Errors in release/release_0_3_0.md
✗ https://forum.image.sc/ (HTTP status client error (403 Forbidden) for url (https://forum.image.sc/))
✗ https://forum.image.sc/t/integration-of-napari-module-subclass-plugin/36018/2 (HTTP status client error (403 Forbidden) for url (https://forum.image.sc/t/integration-of-napari-module-subclass-plugin/36018/2))
✗ https://forum.image.sc/tags/napari (HTTP status client error (403 Forbidden) for url (https://forum.image.sc/tags/napari))

Errors in developers/core_dev_guide.md
✗ https://forum.image.sc/tags/napari (HTTP status client error (403 Forbidden) for url (https://forum.image.sc/tags/napari))

[GenevieveBuckley]

Josh says that we need to set the user agent to fix the 403 forbidden errors with image.sc - https://forum.image.sc/t/how-to-check-for-broken-links-pointing-to-image-sc/58688/2

Lychee has a --user-agent flag you can set.

We'll need something like --user-agent "Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:93.0) Gecko/20100101 Firefox/93.0"

[GenevieveBuckley]

Closing this in favour of newer link checking reports.

Ideally #273 will have fixed any remaining lychee configuration issues - we'll see how well that's actually working next week.