[
https://issues.apache.org/jira/browse/ARROW-13260?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17401675#comment-17401675
]
Joris Van den Bossche commented on ARROW-13260:
-----------------------------------------------
It's also an option to keep "/docs" for the current release as is, without a
redirect to "/docs/stable" (and thus without adding a "/docs/stable" url).
We should indeed make that we don't add unnecessary duplication (like have the
current release twice), but of course we will end up with a large amount of
duplication anyway, because the content of the 4.0 docs or 5.0 docs are largely
the same. I mentioned a link above
(https://developers.google.com/search/docs/advanced/crawling/consolidate-duplicate-urls
) that describes some strategies to help with this. It seems that adding some
"canonical" tag in the html can help, and
https://docs.readthedocs.io/en/stable/guides/canonical.html has some
information about doing that with sphinx.
> [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)
