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

Broken link on installation page for bundled app #5183

Closed
justinelarsen opened this issue Oct 5, 2022 · 8 comments
Closed

Broken link on installation page for bundled app #5183

justinelarsen opened this issue Oct 5, 2022 · 8 comments
Labels
bug Something isn't working documentation

Comments

@justinelarsen
Copy link
Contributor

📚 Documentation

There is "click here" text on this page that does not link anywhere.
https://napari.org/stable/tutorials/fundamentals/installation.html#prerequisites-for-installing-napari-as-a-bundled-app

"Click here to see instructions for installing the bundled app."
The "Click here" text should link to the bundled app installation section below on the same page (https://napari.org/stable/tutorials/fundamentals/installation.html#install-as-a-bundled-app).
Screen Shot 2022-10-05 at 1 58 07 PM

@justinelarsen justinelarsen added bug Something isn't working documentation labels Oct 5, 2022
@psobolewskiPhD
Copy link
Member

This link works for the dev docs (menu in the upper right), so it seems it's been fixed in the repo, but I'm not sure how to go back and fix for that release.

@Carreau
Copy link
Contributor

Carreau commented Oct 6, 2022

See napari/napari.github.io#365, but there is about 92 broken links. Like just in your screenshot "as a Python package instead", should also be a link.

Carreau added a commit to Carreau/napari.github.io that referenced this issue Oct 6, 2022
Note that this is far from the only broken link, in the same issue, the
screenshot shows "as a Python package instead" that should also be a
link.

A quick way to see the number of non-existing links woudl be:

    $ rg 'class="xref myst"' | cut -f1 -d: |cut -f1-2 -d'/' | uniq -c | sort -n
       1 0.4.16/plugins
       1 dev/plugins
       2 0.4.15/index.html
       2 0.4.16/index.html
       2 0.4.16/tutorials
       4 0.4.16/roadmaps
       5 0.4.16/plugins
       6 0.4.15/plugins
       7 0.4.15/tutorials
       8 0.4.16/roadmaps
       9 0.4.15/developers
       9 0.4.16/developers
      12 0.4.15/guides
      12 0.4.15/roadmaps
      12 0.4.16/guides

Therefore there are potentially plenty of other links to fix in already
released version.
@justinelarsen
Copy link
Contributor Author

Ah, so many broken links! @Carreau Is there an issue already created to track all those broken links? Thanks for the quick PR to fix this one 😄

@Carreau
Copy link
Contributor

Carreau commented Oct 6, 2022 via email

@justinelarsen
Copy link
Contributor Author

Good question! I don't know, but maybe best to create an issue to track it and then we can gather feedback on that issue to make a decision? The reason I found this was because a user was trying to install napari and had trouble finding the right instructions, so for right now, it is a problem for the stable docs, but I imagine that with time, this will become less of an issue. I would like to hear what others think.

@psobolewskiPhD
Copy link
Member

psobolewskiPhD commented Oct 6, 2022

I mean broken links are obviously bad, so fixing them is good. But this can be semi-dealt with via a warning that the docs are out-dated, see napari/docs#82
Edit: going forward, there is this merged PR #5008 that should help keep links not broken.
Is back propagating link fixes practical? Which version do you stop at?

@justinelarsen
Copy link
Contributor Author

Cool! Good to see #5008 going forward. Since 0.4.17 will be released soon, maybe the warning banner is more practical. Either way, I really like that proposed addition.

jni pushed a commit to napari/napari.github.io that referenced this issue Oct 30, 2022
@psobolewskiPhD
Copy link
Member

This is fixed in every version of the live page on napari.org (0.4.15, 16, 17, and dev).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation
Projects
None yet
Development

No branches or pull requests

3 participants