cabal icon indicating copy to clipboard operation
cabal copied to clipboard

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

Open malteneuss opened this issue 2 years ago • 3 comments

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.

malteneuss avatar Jan 12 '24 20:01 malteneuss

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...

ulysses4ever avatar Jan 12 '24 20:01 ulysses4ever

@andreasabel: any ideas?

Mikolaj avatar Jan 15 '24 10:01 Mikolaj

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

andreasabel avatar Jan 15 '24 15:01 andreasabel