Skip to content

ARROW-18363: [Docs] Include warning when viewing old docs (redirecting to stable/dev docs) #14687

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
AlenkaF wants to merge 1 commit into from
Closed

ARROW-18363: [Docs] Include warning when viewing old docs (redirecting to stable/dev docs) #14687

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions docs/versionwarning.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
(function() {
// adapted from https://scikit-learn.org/versionwarning.js
var latestStable = '10.0.0';
var showWarning = (msg) => {
$('.bd-header-announcement container-fluid').prepend(
'<p style="' +
[
'padding: 1em',
'font-size: 1.5em',
'border: 1px solid red',
'background: pink',
].join('; ') +
'">' + msg + '</p>')
};
if (location.hostname == 'arrow.apache.org') {
var versionPath = location.pathname.split('/')[2];
if (versionPath == 'developers') {
// developers section in the stable version
showWarning('This is documentation for the stable version ' +
'of Apache Arrow. For latest contributing practices ' +
'switch to unstable development ' +
'release <a href="https://arrow.apache.org/docs/dev/developers/contributing.html">version ' +
latestStable + '</a>.')
} else if (versionPath.match(/^\d/) || location.pathname.split('/')[3] == 'developers') {
// older versions of developers section (with numbered version in the URL)
showWarning('This is documentation for an old release of Apache Arrow ' +
'(version ' + versionPath + '). For latest development practices ' +
'switch to unstable development release ' +
'<a href="https://arrow.apache.org/docs/dev/developers/contributing.html">version ' +
latestStable + '</a>.')
} else if (versionPath == 'dev') {
// older versions (with numbered version in the URL)
showWarning('This is documentation for an old release of ' +
'Apache Arrow (version ' + versionPath + '). Try the ' +
'<a href="https://arrow.apache.org/docs/index.html">latest stable ' +
'release</a> (version ' + latestStable + ') or ' +
'<a href="https://arrow.apache.org/docs/dev/index.html">development</a> ' +
'(unstable) version.')
} else if (versionPath == 'dev') {
showWarning('This is documentation for the unstable ' +
'development version of Apache Arrow.' +
'The latest stable ' +
'release is <a href="https://arrow.apache.org/docs/index.html">version ' +
latestStable + '</a>.')
}
}
})()