Project

General

Profile

Actions

Bug #24337

open

Google searches typically hit old Ceph version docs, with no easy way to navigate to equiv latest stable docs

Added by Tim Small almost 6 years ago. Updated over 4 years ago.

Status:
New
Priority:
Normal
Assignee:
-
% Done:

0%

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

Description

docs.ceph.com frequently comes up as the top link when google for ceph topics, however this is usually a link to the documentation from an old stable release (normally Jewel, but frequently older EOL releases such as Firefly), and the user is not provided with any easy way to know that they may not be looking at the right version unless they:
. happen to check the URL, and
. have familiarity with ceph release code names (unlikely for new users)

e.g. google for: "ceph cache tiering" get's this as the top link:

http://docs.ceph.com/docs/jewel/rados/operations/cache-tiering/

with no other ceph.com docs appearing on the front page of the google results.

I've given this issue "bug" status, because I think this could lead to user mistakes due to following outdated documentation.

Even worse, google for this:

ceph release history

gives this as the top hit, which is a bit ridiculous: http://docs.ceph.com/docs/jewel/releases/ and makes it looks like no releases have happened since April 2016

I'd suggest a prominent (maybe shrinkable and/or dismissable) header bar at the top of each docs page (especially those for older releases) which says something like:

This documentation is for Ceph vX.Y.Z ("foo") released on DD-MM-YY, for the same documentation for the latest stable release, follow this link [which would preferably link to the equivalent latest stable release page, or otherwise to the ToC if that page is a 404].

Moreover, pages like this http://docs.ceph.com/docs/jewel/releases/ should probably always link to the equiv most up-to-date page.

Actions #1

Updated by David Galloway over 4 years ago

  • Project changed from 37 to www.ceph.com
Actions #2

Updated by Sage Weil over 4 years ago

  • Project changed from www.ceph.com to website
Actions

Also available in: Atom PDF