Ceph » mgr » Dashboard

The move from docs.ceph.com to readthedocs.io changed the structure of the documentation, which breaks the URLs embedded in the Dashboard. While we could of course update the URLs in Dashboard, I suggest to first figure out if it's possible to set up "compatibility links" or automatic redirects from the old URL structure to the new one, as it's likely that this change breaks quite a lot of external pages that point to our documentation.

Lenz Grimmer wrote:

The move from docs.ceph.com to readthedocs.io changed the structure of the documentation, which breaks the URLs embedded in the Dashboard. While we could of course update the URLs in Dashboard, I suggest to first figure out if it's possible to set up "compatibility links" or automatic redirects from the old URL structure to the new one, as it's likely that this change breaks quite a lot of external pages that point to our documentation.

readthedocs.io does actually support this: https://docs.readthedocs.io/en/stable/user-defined-redirects.html

This is the current diff: how it was before RTD vs. now:

- https://docs.ceph.com/en/docs/octopus/mgr/dashboard/#configuring-nfs-ganesha-in-the-dashboard
+ https://docs.ceph.com/en/octopus/mgr/dashboard/#configuring-nfs-ganesha-in-the-dashboard

The redirection rule of master branch works. Non-root URLs don't redirect for Octopus and Nautilus branches.

i cannot think of a way to redirect the http://docs.ceph.com/docs/${release}/mgr/dashboard/#configuring-nfs-ganesha-in-the-dashboard to http://docs.ceph.com/en/${release}/mgr/dashboard/#configuring-nfs-ganesha-in-the-dashboard

this requires the feature of prefix + matching so

${domain}/docs/${release}/* can be redirected to ${domain}/en/${release}/*

but what RTD offers is

${domain}/${prefix}/* => ${domain}/${lang}/${version}/*

where "${lang}" and "${version}" are predefined default values, in our case, they are "en" and "latest".

EDIT, i added a Exact Redirect rule with "$rest" keyword, which did the trick.