GH-46956: [Docs][CI] Enable version switcher in local and PR preview build#46957
Conversation
AlenkaF
requested review from
assignUser,
jonkeane,
kou and
raulcd
as code owners
github-actions
Bot
added
Component: Documentation
awaiting review
There was a problem hiding this comment.
Using the local relative path here doesn't work as expected, so the online https:// URL is used for now.
|
@github-actions crossbow submit preview-docs |
github-actions
Bot
added
awaiting committer review
|
Revision: 890cb6ea67ca7368399501061c659a519d28cbb8 Submitted crossbow builds: ursacomputing/crossbow @ actions-119dd58bd4
|
AlenkaF
force-pushed
the
gh-46956-docs-dev-build
branch
from
890cb6e to
995e1ca
Compare
|
@github-actions crossbow submit preview-docs |
|
Revision: 69bc2a9 Submitted crossbow builds: ursacomputing/crossbow @ actions-b39dd3f51f
|
AlenkaF
force-pushed
the
gh-46956-docs-dev-build
branch
from
69bc2a9 to
6e9df36
Compare
|
@github-actions crossbow submit preview-docs |
|
Revision: 6e9df36 Submitted crossbow builds: ursacomputing/crossbow @ actions-7daf943a1f
|
AlenkaF
force-pushed
the
gh-46956-docs-dev-build
branch
from
6e9df36 to
66d4611
Compare
|
OK, I think the last solution works (and is simpler). Here is the crossbow preview from this PR (https://s3.amazonaws.com/arrow-data/pr_docs/46957/index.html): 
and here is the preview from a different PR (https://s3.amazonaws.com/arrow-data/pr_docs/49947/index.html): 
where a version switcher is not being displayed. This is a small change but will make local dev experience nicer. cc @kou in case you have some bandwidth to review this. |
|
Ah, version switcher can be displayed but links to https://arrow.apache.org/docs/ . Version switcher may not provide full features in preview but we can check what displayed now. |
|
After merging your PR, Conbench analyzed the 4 benchmarking runs that have been run so far on merge-commit d40c02e. There weren't enough matching historic benchmark results to make a call on whether there were regressions. The full Conbench report has more details. |
Yes, correct. To make all the links point to the working version (dev folders) might be possible with providing a dev version of the |
…eview build (apache#46957) ### Rationale for this change Currently, the version switcher is not functional in local builds or in PR preview docs via crossbow, since it relies on the versions.json file from the arrow site. This makes it difficult to test changes to the switcher configuration or verify that nothing breaks with new theme updates. ### What changes are included in this PR? The version switcher is enabled in a dev setup by: - Using online versions.json file when building locally or in PR preview - Falling back to the arrow-site JSON otherwise ### Are these changes tested? Yes, preview-docs build. ### Are there any user-facing changes? No, only local testing is simplified. * GitHub Issue: apache#46956 Authored-by: AlenkaF <frim.alenka@gmail.com> Signed-off-by: Sutou Kouhei <kou@clear-code.com>
2 participants
Rationale for this change
Currently, the version switcher is not functional in local builds or in PR preview docs via crossbow, since it relies on the versions.json file from the arrow site.
This makes it difficult to test changes to the switcher configuration or verify that nothing breaks with new theme updates.
What changes are included in this PR?
The version switcher is enabled in a dev setup by:
Are these changes tested?
Yes, preview-docs build.
Are there any user-facing changes?
No, only local testing is simplified.