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

Allow deep linking to version aliases in the docs #239

Open
llucax opened this issue Apr 12, 2024 · 0 comments
Open

Allow deep linking to version aliases in the docs #239

llucax opened this issue Apr 12, 2024 · 0 comments
Labels
part:mkdocs Affects the configuration of mkdocs part:template Affects the cookiecutter template files type:enhancement New feature or enhancement visitble to users
Milestone

Comments

@llucax
Copy link
Contributor

llucax commented Apr 12, 2024

What's needed?

We need to be able to use deep links to a particular version alias in the docs.

Proposed solution

Change the alias_type in the mike section in mkdocs.yml to use symlink instead of redirect.

Additional context

GitHub pages stopped supporting symlinks at some point unless they were built using GitHub Actions. Back then this was not the default and we didn't use GHA, so we had to change the config to use redirect instead. This is not ideal because we can't have deep link to a particular version that is an alias.

This setting was changed (or set explicitly to redirect) here:

@llucax llucax added type:enhancement New feature or enhancement visitble to users part:mkdocs Affects the configuration of mkdocs part:template Affects the cookiecutter template files labels Apr 12, 2024
@llucax llucax added this to the v0.10.0 milestone Apr 12, 2024
@llucax llucax modified the milestones: v0.10.0, v0.11.0 Jul 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
part:mkdocs Affects the configuration of mkdocs part:template Affects the cookiecutter template files type:enhancement New feature or enhancement visitble to users
Projects
None yet
Development

No branches or pull requests

1 participant