[doc] strange navigation error

[doc] strange navigation error

[Travis Rhoden]

I stumbled across a weird TOC/navigation error in the docs.

On the page: http://ceph.com/docs/master/rados/deployment/ceph-deploy-mds/,
if you hover over "next" on the top right, it wants to go to
mds-config-ref, even though the TOC on the left says the next entry
should be ceph-deploy-purge.  You can get to ceph-deploy-purge by
clicking the link in the left-hand TOC, but you can't navigate to it
by going "next, next, next" through all docs.  I find this to be a
little weird, as I was trying to read through all the ceph-deploy docs

Weirdly, once on ceph-deploy-purge, the navigation is fine --
including that "previous" takes you to ceph-deploy-mds.  Weird.  I
looked at all the .rst files and didn't see anything obvious.

I finally tracked down the issue to doc/cephfs/index.rst, which has
this in its TOC.  From my perspective, this makes the navigation
confusing, and I would remove it.  But I figured I'd bring it to
John's attention first before submitting a pull-request.

And that came in with commit:
decf342c (John Wilkins 2013-05-17 15:56:59 -0700 46), with the comment
doc: Minor improvements to Ceph FS landing page.

While it may help the CephFS landing page, I think it makes navigation
through the ceph-deploy docs not very intuitive.

 - Travis

Re: [doc] strange navigation error

[Dan Mick]

On 05/24/2013 10:05 AM, Travis Rhoden wrote:
> I stumbled across a weird TOC/navigation error in the docs.
>
> On the page: http://ceph.com/docs/master/rados/deployment/ceph-deploy-mds/,
> if you hover over "next" on the top right, it wants to go to
> mds-config-ref, even though the TOC on the left says the next entry
> should be ceph-deploy-purge.

Ah.  That's because the TOC *also* says that the next is MDS 
Configuration (under CephFS).  I guess we're sharing the Add/Remove MDS 
page at two places in the hierarchy.

-- 
Dan Mick, Filesystem Engineering
Inktank Storage, Inc.	http://inktank.com
Ceph docs: http://ceph.com/docs

Re: [doc] strange navigation error

[Travis Rhoden]

On Fri, May 24, 2013 at 4:55 PM, Dan Mick <dan.mick@inktank.com> wrote:
>
>
> On 05/24/2013 10:05 AM, Travis Rhoden wrote:
>>
>> I stumbled across a weird TOC/navigation error in the docs.
>>
>> On the page:
>> http://ceph.com/docs/master/rados/deployment/ceph-deploy-mds/,
>> if you hover over "next" on the top right, it wants to go to
>> mds-config-ref, even though the TOC on the left says the next entry
>> should be ceph-deploy-purge.
>
>
> Ah.  That's because the TOC *also* says that the next is MDS Configuration
> (under CephFS).  I guess we're sharing the Add/Remove MDS page at two places
> in the hierarchy.

Yes, that is exactly what is happening.  Since the Add/Remove MDS page
is specific to ceph-deploy, I would think you want to keep it in the
ceph-deploy section, and not add it ot the TOC a second time from the
CephFS section.  We could instead a reference/link to it, but a page
should really only ever be in one TOC.  If someone says that is okay
to do, I can send a pull-request with the offending line removed (and
potentially a reference/link instead).

 - Travis
>
> --
> Dan Mick, Filesystem Engineering
> Inktank Storage, Inc.   http://inktank.com
> Ceph docs: http://ceph.com/docs

Re: [doc] strange navigation error

[Dan Mick]

On 05/24/2013 02:16 PM, Travis Rhoden wrote:
> On Fri, May 24, 2013 at 4:55 PM, Dan Mick <dan.mick@inktank.com> wrote:
>>
>>
>> On 05/24/2013 10:05 AM, Travis Rhoden wrote:
>>>
>>> I stumbled across a weird TOC/navigation error in the docs.
>>>
>>> On the page:
>>> http://ceph.com/docs/master/rados/deployment/ceph-deploy-mds/,
>>> if you hover over "next" on the top right, it wants to go to
>>> mds-config-ref, even though the TOC on the left says the next entry
>>> should be ceph-deploy-purge.
>>
>>
>> Ah.  That's because the TOC *also* says that the next is MDS Configuration
>> (under CephFS).  I guess we're sharing the Add/Remove MDS page at two places
>> in the hierarchy.
>
> Yes, that is exactly what is happening.  Since the Add/Remove MDS page
> is specific to ceph-deploy, I would think you want to keep it in the
> ceph-deploy section, and not add it ot the TOC a second time from the
> CephFS section.  We could instead a reference/link to it, but a page
> should really only ever be in one TOC.  If someone says that is okay
> to do, I can send a pull-request with the offending line removed (and
> potentially a reference/link instead).
>
>   - Travis
>>


Sure.  I'm gonna go look at your earlier pull request now, too.  Thanks.