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

Cabal documentation has some broken links when changing between latest and other versions #9613

Open
malteneuss opened this issue Jan 12, 2024 · 3 comments
Labels
documentation re: readthedocs Concerning hosting documentation on `readthedocs` type: bug

Comments

@malteneuss
Copy link
Collaborator

Describe the bug
Cabal documentation has broken links when changing between latest and other version for pages whose slug/path had been changed

To Reproduce
E.g. https://cabal.readthedocs.io/en/latest/how-to-package-haskell-code.html when changing to stable.

Additional context
Continuation of #9379.

I can't find any convenient or declarative support for page renamings in readthedocs, only explicit redirects where for every page we would have to provide the redirects are triples

Type: Page Redirect
From URL: /en/stable/how-to-package-haskell-code.html
To URL: /en/stable/developing-packages.html

and add them manually or through the readthedocs http api to the settings as an admin.

Has anyone a better idea? If not i can try to compile a list of triplets.

@ulysses4ever
Copy link
Collaborator

ulysses4ever commented Jan 12, 2024

Thanks for looking into it! I don't know of a better way but I also haven't looked into it too closely. Reading the page you referenced, it does seem like RTD suggests that our use-case matches the purpose of their redirect mechanism.

I can't find any convenient or declarative support for page renamings in readthedocs

When I saw the syntax you show, I thought it was pretty declarative. But then I got to the page that explains how to actually setup those redirects through the admin panel, and it is very much imperative, unfortunately, as you say. We don't change the documentation engine all that often, so maybe it's fine to do it manually once and see how it works for us...

@Mikolaj @Kleidukos any thoughts? Maybe people think that the changed URLs are not an issue at all? Or have better ideas...

@Mikolaj
Copy link
Member

Mikolaj commented Jan 15, 2024

@andreasabel: any ideas?

@andreasabel
Copy link
Member

I have never looked into RTD redirects, so, no opinion...

@ulysses4ever ulysses4ever added documentation re: readthedocs Concerning hosting documentation on `readthedocs` and removed needs triage labels Mar 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation re: readthedocs Concerning hosting documentation on `readthedocs` type: bug
Projects
None yet
Development

No branches or pull requests

4 participants