[
https://issues.apache.org/jira/browse/ARROW-13260?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17400249#comment-17400249
]
Joris Van den Bossche commented on ARROW-13260:
-----------------------------------------------
Copying from our meeting notes: we should take steps to avoid Google sending
users to anything but the latest version (unless perhaps they are explicitly
searching for an older version).
https://developers.google.com/search/docs/advanced/crawling/consolidate-duplicate-urls
might have some pointers on how to do this.
As a first step, I created a PR to add the existing releases in subdirs:
https://github.com/apache/arrow-site/pull/139
One point for discussion (or bike shedding :)): what url do we want to use for
the "current release" docs?
Readthedocs (and therefore quite some python packages) use the "stable" and
"latest" for latest release and dev version, respectively (but I think it's not
uncommon that people interpret "latest" as latest release and not latest
development version ...). We could also use "stable" and "dev" to make this
clearer.
Another option is to _not_ use a tag for the current docs, so just use eg
/docs/format/Columnar.html for the current release and then eg
/docs/4.0/format/Columnnar.html for an older release. (this might also solve
the issue about how to redirect/link the current pages to something with
/stable/..)
> [Doc] Host different released versions of the documentation + version switcher
> ------------------------------------------------------------------------------
>
> Key: ARROW-13260
> URL: https://issues.apache.org/jira/browse/ARROW-13260
> Project: Apache Arrow
> Issue Type: Improvement
> Components: Documentation
> Reporter: Joris Van den Bossche
> Assignee: Joris Van den Bossche
> Priority: Major
> Fix For: 6.0.0
>
> Time Spent: 10m
> Remaining Estimate: 0h
>
> Related to ARROW-1299 for hosting the nightly docs, we could also keep the
> built docs for older versions instead of overwriting them at each release.
> Currently, the built docs live in the apache/arrow-site repo (asf-site
> branch) in the "/docs/" subdirectory.
> When releasing, we could add the newly built docs for that release in a
> subdirectory instead. Something like "/docs/5.0/" or "/docs/version/5.0".
> (And we could retroactively add some docs of previous releases, if we want)
> To make this useful for the user, we need a version switcher in the sphinx
> theme layout. There are other projects that use the same sphinx theme that
> have added this (see eg https://mne.tools/stable/index.html), and there is
> some work to upstream this to the base theme (but on the short term we could
> also copy such a custom implementation).
> For the "stable" docs (latest release), we could either 1) keep a duplicated
> version of the latest built docs at "/docs/", or 2) symlink "/docs/" to
> "/docs/5.0/" (and update this for each release; although I am not sure this
> is possible since it's the other is a child directory).
> We could also add a "/docs/stable/" and make this the default url.
> cc [~amol-] [~kszucs]
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
