You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jira@arrow.apache.org by "Joris Van den Bossche (Jira)" <ji...@apache.org> on 2022/12/23 08:47:00 UTC
[jira] [Resolved] (ARROW-18363) [Docs] Include warning when viewing old docs (redirecting to stable/dev docs)
[ https://issues.apache.org/jira/browse/ARROW-18363?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Joris Van den Bossche resolved ARROW-18363.
-------------------------------------------
Fix Version/s: 11.0.0
Resolution: Fixed
Issue resolved by pull request 14839
https://github.com/apache/arrow/pull/14839
> [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
> Assignee: Alenka Frim
> Priority: Major
> Labels: pull-request-available
> Fix For: 11.0.0
>
> Time Spent: 7h 20m
> Remaining Estimate: 0h
>
> 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)