Ceph » CephFS

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

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/.

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

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

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.