Ken,
Thanks for this pointer about canonical. It looks like the following
is a fairly common scheme:
The non-versioned URL (e.g. docs.domain or
docs.domain/{latest,manual,en}) is 302 redirected to the latest
release (e.g. docs.domain/v3.2). Then all versions of documentation
include in their header a a canonical link as you described, which
points to the current page in the latest versions of the document. For
example:
A page for a feature in version 1.x of documentation will include
(e.g. docs.domain/v1.x/feature)
<link href="docs.domain/latest/feature" rel="canonical">
Some sites point the canonical URL to the specific version of the
latest documentation. That's probably less than optimal for us because
we'd either need to regenerate all the docs or have some sort of
dynamic component to inject that after new releases. Using the 302
redirect should consolidate that change.
On Tue, Sep 25, 2018 at 8:35 AM Ken Dreyer <kdreyer@xxxxxxxxxx> wrote:
>
> In other documentation sites that have multiple software versions,
> like http://httpd.apache.org/docs, or readthedocs.org, they use "<link
> href="url/to/the/current/docs" rel="canonical" />" to indicate to
> search engines what content is canonical. We could insert something
> into our doc templates like this to point at the master branch
> version.
> On Mon, Sep 24, 2018 at 5:49 PM Noah Watkins <noahwatkins@xxxxxxxxx> wrote:
> >
> > I was googling this morning for random ceph terminology, as one does,
> > and noticed that the top 5 results often included some deep cuts like
> > kraken/bobtail/giant etc... it'd be really nice to have some sort of
> > visual cue about the freshness of the docs being viewed.
> >
> > Following up on Neha's comments from this morning's meeting regarding
> > documentation improvements, Neha and I brainstormed some ideas this
> > afternoon and tossed them in an etherpad:
> >
> > https://pad.ceph.com/p/Ceph_Documentation
> >
> > Please feel free to add / edit / comment.
