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

Joris Van den Bossche commented on ARROW-18363:
-----------------------------------------------

Renamed the issue to not be specific about the contributing docs, since we can 
also do this for all docs. I think it would only still be nice if we can 
special case pages in the /developers section, so that for those pages we can 
1) point to the dev docs instead of stable docs, and 2) also show this warning 
for the stable version.

> [Docs] Include warning when viewing old docs (redirecting to stable/dev docs)
> -----------------------------------------------------------------------------
>
>                 Key: ARROW-18363
>                 URL: https://issues.apache.org/jira/browse/ARROW-18363
>             Project: Apache Arrow
>          Issue Type: Improvement
>          Components: Documentation
>            Reporter: Joris Van den Bossche
>            Priority: Major
>
> Now we have versioned docs, we also have the old versions of the developers 
> docs (eg 
> https://arrow.apache.org/docs/9.0/developers/guide/communication.html). Those 
> might be outdated (eg regarding communication channels, build instructions, 
> etc), and typically when contributing / developing with the latest arrow, one 
> should _always_ check the latest dev version of the contributing docs.
> We could add a warning box pointing this out and linking to the dev docs. 
> For example similarly how some projects warn about viewing old docs in 
> general and point to the stable docs (eg https://mne.tools/1.1/index.html or 
> https://scikit-learn.org/1.0/user_guide.html). In this case we could have a 
> custom box when at a page in /developers to point to the dev docs instead of 
> stable docs



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

Reply via email to