Project

General

Profile

Bug #48012

mgr/dashboard: documentation links do not work on octopus, nautilus or older Ceph versions in general

Added by Tatjana Dehler about 2 years ago. Updated over 1 year ago.

Status:
Closed
Priority:
Normal
Assignee:
Category:
Docs
Target version:
-
% Done:

0%

Source:
Community (dev)
Tags:
Backport:
Regression:
No
Severity:
3 - minor
Reviewed:
Affected Versions:
ceph-qa-suite:
Pull request ID:
Crash signature (v1):
Crash signature (v2):

Description

If I e.g. clicked on NFS and the link in the text: "NFS-Ganesha cluster is not detected. Please set the GANESHA_RADOS_POOL_NAMESPACE setting or deploy an NFS-Ganesha cluster with the Orchestrator. Please consult the documentation on how to configure and enable the NFS Ganesha management functionality.". It led me to https://docs.ceph.com/en/docs/octopus/mgr/dashboard/#configuring-nfs-ganesha-in-the-dashboard


Related issues

Related to Dashboard - Bug #48294: mgr/dashboard: links to documentation broken Resolved

History

#1 Updated by Tatjana Dehler about 2 years ago

  • Subject changed from mgr/dashboard: documentation links do not work on octopus to mgr/dashboard: documentation links do not work on octopus, nautilus or older Ceph versions in general

#2 Updated by Lenz Grimmer about 2 years ago

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.

#3 Updated by Lenz Grimmer about 2 years ago

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

#4 Updated by Ernesto Puerta about 2 years ago

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

#6 Updated by Kefu Chai about 2 years ago

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.

#7 Updated by Kefu Chai about 2 years ago

  • Status changed from New to Fix Under Review
  • Assignee set to Kefu Chai
  • Pull request ID set to 38061

#8 Updated by Ernesto Puerta about 2 years ago

  • Related to Bug #48294: mgr/dashboard: links to documentation broken added

#9 Updated by Kefu Chai about 2 years ago

  • Status changed from Fix Under Review to Resolved

#10 Updated by Ernesto Puerta about 2 years ago

  • Status changed from Resolved to Closed

#11 Updated by Ernesto Puerta over 1 year ago

  • Project changed from mgr to Dashboard
  • Category changed from 175 to Docs

Also available in: Atom PDF