Project

General

Profile

Bug #36416

Documentation links on ceph "dev" versions

Added by Ricardo Marques over 5 years ago. Updated almost 3 years ago.

Status:
Resolved
Priority:
Low
Assignee:
-
Category:
General
Target version:
-
% Done:

0%

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

Description

Currently documentations links are pointing to the nautilus documentation [1] which results in a "404 Not found" page because Nautilus was not released yet.

This issue will never happen in production, but it would be great if documentation links can point to master documentation on ceph dev versions.

Development version example:

"ceph version 14.0.0-4026-g79d3679293 (79d367929342637f0e87c7c98a1d614a0b19fdff) nautilus (dev)"

Production version example:

"ceph version 12.2.7-420-gc0ef85b854 (c0ef85b8544d85079fa7b1643ff944121eb51513) luminous (stable)"

[1] http://docs.ceph.com/docs/nautilus/mgr/dashboard/
[2] http://docs.ceph.com/docs/master/mgr/dashboard/

History

#1 Updated by Ricardo Marques over 5 years ago

  • Priority changed from Normal to Low
  • Tags set to low-hanging-fruit

#2 Updated by Ricardo Marques over 5 years ago

  • Subject changed from Documentation links on ceph "dev" version to Documentation links on ceph "dev" versions

#3 Updated by Ricardo Marques over 5 years ago

  • Description updated (diff)

#4 Updated by Ricardo Marques over 5 years ago

  • Description updated (diff)

#5 Updated by Ricardo Marques over 5 years ago

  • Description updated (diff)

#6 Updated by Patrick Seidensal over 5 years ago

  • Description updated (diff)

#7 Updated by Nathan Cutler over 5 years ago

The bug description says "documentations links are pointing to the nautilus documentation", but I could not find any such links. Would it make sense to provide a list of such broken links, or at least some examples?

Here is how I searched for the broken links:

smithfarm@wilbur:~/src/ceph/smithfarm/ceph/doc> git pull
Already up to date.
smithfarm@wilbur:~/src/ceph/smithfarm/ceph/doc> git status
On branch master
Your branch is up to date with 'ceph/master'.

nothing to commit, working tree clean
smithfarm@wilbur:~/src/ceph/smithfarm/ceph/doc> ag nautilus
releases/schedule.rst
410:(12.2.z) will reach end of life (EOL) shortly after Nautilus (14.2.0) is

releases/mimic.rst
252:* mon: don't require CEPHX_V2 from mons until nautilus (`pr#23233 <https://github.com/ceph/ceph/pull/23233>`_, Sage Weil)
255:* osd/OSDMap: fix CEPHX_V2 osd requirement to nautilus, not mimic (`pr#23250 <https://github.com/ceph/ceph/pull/23250>`_, Sage Weil)

#8 Updated by Ricardo Marques over 5 years ago

@Nathan Cutler your search is not working because this link is not hard-coded, this link is generated base on the release name:

https://github.com/ceph/ceph/blob/master/src/pybind/mgr/dashboard/frontend/src/app/core/navigation/dashboard-help/dashboard-help.component.ts#L31

#9 Updated by Zack Cerza over 5 years ago

Comparing master's ceph_release file with mimic's:

14
nautilus
dev

vs.
13
mimic
stable

I wonder if it would be reasonable to, if we see '(dev)' as opposed to '(stable)' in the version string, assume we're actually running master?

#10 Updated by Ricardo Marques over 5 years ago

IMO it's acceptable to assume that if version includes "(dev)", we point to master documentation (even if we are using a previous release - e.g., "mimic (dev)").

Other possible solution would be to check if the documentation URL is available (HTTP 200), and if it's not (HTTP 404) we redirect to "master" documentation, but this requires an additional request which I think it's not worth it.

#11 Updated by Zack Cerza over 5 years ago

  • Status changed from New to Fix Under Review

#12 Updated by Zack Cerza over 5 years ago

  • Status changed from Fix Under Review to Resolved

#13 Updated by Ernesto Puerta almost 3 years ago

  • Project changed from mgr to Dashboard
  • Category changed from 132 to General

Also available in: Atom PDF