-
Notifications
You must be signed in to change notification settings - Fork 109
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.
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
ARROW-18363: [Docs] Include warning when viewing old docs (redirecting to stable/dev docs) #275
Conversation
I can't officially "approve" the PR as I don't get into the Files changed tab (it indicates an infinity of touched files ...). But from a local checkout, this looks good! |
One small thing -> We will also have to update the release script for the docs to update that line ( |
Oh thanks for reminding me of that!! Will correct the version here and update the release script together with updating |
Thanks for the update! Let's give this a try |
Seems to be working fine! |
…g to stable/dev docs) (#14839) This PR is a complementary work to apache/arrow-site#275. It adds a version warning script tag to the `docs/source/_templates/layout.html` and _versionwarnings.js_ file into `docs/source/_static/`. Authored-by: Alenka Frim <frim.alenka@gmail.com> Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
…g to stable/dev docs) (apache#14839) This PR is a complementary work to apache/arrow-site#275. It adds a version warning script tag to the `docs/source/_templates/layout.html` and _versionwarnings.js_ file into `docs/source/_static/`. Authored-by: Alenka Frim <frim.alenka@gmail.com> Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
Link to the Jira issue: https://issues.apache.org/jira/browse/ARROW-18363.
This PR inserts a script element into all
.html
files which calls a/docs/versionwarning.js
file. The file adds a version warning to the.html
page if the file path matches any of the 4 criteria:Each of these warnings has its own warning message.
This PR is a part of Jira to GitHub migration work.
Hot to test the code locally?
arrow-site/asf-site
other than this onearrow-site/docs/
folderMy path to
arrow-site/docs
is/Users/alenkafrim/repos/arrow-site/docs
and is a "length" of 5 so numbers I used down below were 6&7. If the length of you path is 7 then you need to change 6 with 8 and 7 with 9 😬I am searching for a shell function to give the length and I can automate this step =)
This is the visual from my local tests: