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

When a link does not reference a version, it produces a 404. #170

Closed
laurafitzgerald opened this issue Jan 14, 2025 · 4 comments
Closed

Comments

@laurafitzgerald
Copy link
Contributor

laurafitzgerald commented Jan 14, 2025

Is it possible to inject latest as the default version?
Example of this is referenced in Kuadrant/authorino#513
This would save broken links needing to be fixed.
We already use aliases described here https://github.com/Kuadrant/docs.kuadrant.io?tab=readme-ov-file#mike-aliases not sure if that can provide us with a fix for this.

@jasonmadigan
Copy link
Member

I looked into this at one point, as previously we had some doc sets published by default beneath /

Unfortunately, there didn't seem to be a way to create a blank/default version in mike that could be aliased to something else (e.g. a '' -> '/' version) to catch these, so I think we're stuck fixing them as we spot. Thankfully there are less now, some PRs a few months ago fixed most of the broken links

@laurafitzgerald
Copy link
Contributor Author

Thanks @jasonmadigan I made updates to the existing links to point to latest. I noticed since tho that there is a dev version. Which of the two latest/dev do you think could be more appropriate for links inside authorino repo for example?

@david-martin
Copy link
Member

Which of the two latest/dev do you think could be more appropriate for links inside authorino repo for example

I'd avoid linking to /dev as docs there may contain unreleased features and such.
Using /latest is safer, though there's an expectation that the url stays around. That's something to keep in mind. If a linked page moves or is being removed, the content can be updated and/or a redirect added for that page (see #187 where the redirects plugin was added)

@david-martin
Copy link
Member

david-martin commented Jan 28, 2025

@laurafitzgerald I'm going to close this, given the comments above.
Please do reopen if you think there's more we can do here, given the limitations of mkdocs, mike and gh pages.
I think the redirects option, though manual and case by case, is better than nothing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

No branches or pull requests

3 participants