Project

General

Profile

Bug #45344

doc: Table Of Contents doesn't work

Added by Jos Collin over 1 year ago. Updated 6 months ago.

Status:
Resolved
Priority:
Normal
Assignee:
Category:
Administration/Usability
Target version:
-
% Done:

0%

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

Description

1. Click here: https://docs.ceph.com/docs/master/cephfs/

2. Click 'Getting Started with CephFS'. It works.

3. But Click Administration, Mounting CephFS, CephFS Concepts, Troubleshooting and Disaster Recovery, Developer Guides, Additional Details. Doesn't work, no action.

History

#1 Updated by Greg Farnum over 1 year ago

I think this is a project-wide thing that Zach (docs guy) already has a ticket for?

#2 Updated by Jos Collin over 1 year ago

Greg Farnum wrote:

I think this is a project-wide thing that Zach (docs guy) already has a ticket for?

No, I see this issue only under https://docs.ceph.com/docs/master/cephfs/.

#3 Updated by Jos Collin 11 months ago

  • Category set to Administration/Usability
  • Assignee set to Zac Dover
  • Source set to Community (dev)

#4 Updated by Zac Dover 11 months ago

There's strange behavior here.

The top-level menu items link nowhere, but the second-order menu items link to targets. For example, the top level menu item "Mounting CephFS" should link to https://docs.ceph.com/en/latest/cephfs/mounting-cephfs (when in fact it links to https://docs.ceph.com/en/latest/cephfs/#mounting-cephfs ), but "Client Configuration Settings", which is the child of "Mounting CephFS" does correctly and as expected link to https://docs.ceph.com/en/latest/cephfs/client-config-ref/.

This Sphinx reference material necessary to fix this (probably) concerns toctrees, and is here: https://www.sphinx-doc.org/en/1.5/markup/toctree.html

#5 Updated by Jos Collin 11 months ago

Zac Dover wrote:

There's strange behavior here.

The top-level menu items link nowhere, but the second-order menu items link to targets. For example, the top level menu item "Mounting CephFS" should link to https://docs.ceph.com/en/latest/cephfs/mounting-cephfs (when in fact it links to https://docs.ceph.com/en/latest/cephfs/#mounting-cephfs ), but "Client Configuration Settings", which is the child of "Mounting CephFS" does correctly and as expected link to https://docs.ceph.com/en/latest/cephfs/client-config-ref/.

In the earlier design of the cephfs docs homepage, there were links of top-level menu items (Mounting CephFS, CephFS Concepts...) in the homepage, similar to "HTTP Frontends" in [1]. In the newer design, the author decided to remove them, as those links are already there in the tree which caused this issue.

[1] https://docs.ceph.com/en/latest/radosgw/

This Sphinx reference material necessary to fix this (probably) concerns toctrees, and is here: https://www.sphinx-doc.org/en/1.5/markup/toctree.html

#6 Updated by Zac Dover 11 months ago

  • Status changed from New to Fix Under Review
  • Pull request ID set to 37616

#7 Updated by Zac Dover 8 months ago

I spoke to Patrick (the creator and owner of the CephFS documentation) about this, and for the time being, the rst files are going to stay the way that they are. CephFS docs have their own style.

I will leave this issue open in order to capture the complaint.

It is possible that at some future day, these different Ceph guides will all come under the same style rubric.

#8 Updated by Zac Dover 6 months ago

  • Status changed from Fix Under Review to Resolved

An update to the UI made by Kefu Chai in March 2021 fixes this issue.

Also available in: Atom PDF