Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix broken links detected by make linkcheck-files #484

Merged
merged 3 commits into from
Oct 23, 2024

Conversation

melissawm
Copy link
Member

References and relevant issues

Related to
#474

Description

Fixes a number of broken links detected by make linkcheck-files.

A few comments:

  • it looks like this link does not exist anymore: further-resources/sample_data.md:17: [redirected permanently] [digitalpathologyassociation.org/whole-slide-imaging-repository](https://digitalpathologyassociation.org/whole-slide-imaging-repository) to [https://digitalpathologyassociation.org?preview_error](https://digitalpathologyassociation.org/?preview_error). I tried googling but only found this: http://www.wsirepository.org/ and it doesn't load. Any ideas?
  • How can we replace the following link? developers/architecture/app_model.md:288: [broken] https://github.com/napari/napari/blob/main/napari/_app_model/_submenus.py: 404 Client Error: Not Found for url: https://github.com/napari/napari/blob/main/napari/_app_model/_submenus.py I couldn't find SubmenuItem in the codebase, maybe I'm missing something
  • https://github.com/potating-potato has probably deleted their github account. I suggest we convert the links to static text if we want to preserve history.
  • These hackmd docs seem to only be readable if you are logged in: https://hackmd.io/fmKp0If5RkiwWIxYYRdKpg and https://hackmd.io/@talley/SJB_lObBi#What-is-a-virtual-environment Should we make it readable by all, or ignore in the linkcheck?
  • A few links will need to be fixed in npe2, I'll send a follow-up PR for that.
  • This file does not seem to exist anymore, from a search at the btrack repo: tutorials/tracking/cell_tracking.md:229: [broken] https://github.com/quantumjot/btrack/blob/main/models/cell_config.json: 404 Client Error: Not Found for url: https://github.com/quantumjot/btrack/blob/main/models/cell_config.json. Should we replace with a new link?
  • I will add a regex to ignore redirects from docs paths to stuff like "stable/" or "en/latest"

A few items are left, mostly links to old code. I will try to replace with permalinks where I can, but not sure if I'll be able to find all of them. If that's the case I might try to ping the original authors for an appropriate substitution.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Aug 26, 2024
Copy link
Member

@psobolewskiPhD psobolewskiPhD left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow! Thanks for catching all those!
I caught one small issue and left a comment

@psobolewskiPhD
Copy link
Member

Thanks!!
I wonder if we can squeeze this into 0.5.4 if we merge quickly?
cc: @jni

@psobolewskiPhD psobolewskiPhD added this to the 0.5.5 milestone Oct 6, 2024
@melissawm
Copy link
Member Author

Hi all - any other suggestions here?

Copy link
Contributor

@DragaDoncila DragaDoncila left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Let's get this in. Thanks for the ping @melissawm

@DragaDoncila DragaDoncila merged commit e5a66d0 into napari:main Oct 23, 2024
8 checks passed
@psobolewskiPhD
Copy link
Member

Sorry I dropped the ball on this one 😭
Thanks for picking it up!

DragaDoncila pushed a commit that referenced this pull request Nov 8, 2024
# References and relevant issues
Closes #439 
Closes #328
Depends on #484 

# Description
Adds a sphinx linkcheck step to be run once a week. The reported
failures will show up as issues in the repo.

This check can also be triggered manually. I am using the sphinx
linkchecker as it will check all links in the docs, including those
coming from docstrings.

You can see this in action on my fork, here: 
melissawm#16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants