[ 
https://issues.apache.org/jira/browse/ARROW-13260?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17400902#comment-17400902
 ] 

Alessandro Molina commented on ARROW-13260:
-------------------------------------------

One note, I think we want to make sure that `/docs` is a permanent redirect to 
`/docs/stable|latest`, that way we would make sure that we don't end up with 
the documentation indexed twice in search engines. Same way, we probably want 
`/docs/5.0.0` to redirect to `/docs/stable` when `5.0.0` is the current stable 
version and not viceversa because we probably want to avoid people bookmarking 
a specific version and search engines indexing a specific version as the 
current stable one.

> [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)

Reply via email to