You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by "AlenkaF (via GitHub)" <gi...@apache.org> on 2023/10/12 10:45:23 UTC
[PR] GH-37947: [Docs] version_match should match the version from versions.json [arrow]
AlenkaF opened a new pull request, #38241:
URL: https://github.com/apache/arrow/pull/38241
This PR corrects the version for the `version_match` to be equal to the version defined in versions.json. This way the text is correctly displayed in the version switcher button.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-38240: [Docs] version_match should match the version from versions.json [arrow]
Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on code in PR #38241:
URL: https://github.com/apache/arrow/pull/38241#discussion_r1361629238
##########
docs/source/conf.py:
##########
@@ -288,6 +288,14 @@
# documentation.
#
+switcher_version = version
+if ".dev" in version:
+ switcher_version = "dev/"
+else:
+ # If we are not building dev version of the docs, we are building
+ # docs for the stable version
+ switcher_version = ""
Review Comment:
I am in favour of the second approach (patch the doc sources when moving) 👍
So this PR can be merged as is, the patch can be added as a follow up after the release, right?
##########
docs/source/conf.py:
##########
@@ -288,6 +288,14 @@
# documentation.
#
+switcher_version = version
+if ".dev" in version:
+ switcher_version = "dev/"
+else:
+ # If we are not building dev version of the docs, we are building
+ # docs for the stable version
+ switcher_version = ""
Review Comment:
I am in favour of the second approach (patch the doc sources when moving) 👍
So this PR can be merged as is, the patch can be added as a follow up after the release, right?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-38240: [Docs] version_match should match the version from versions.json [arrow]
Posted by "jorisvandenbossche (via GitHub)" <gi...@apache.org>.
jorisvandenbossche commented on code in PR #38241:
URL: https://github.com/apache/arrow/pull/38241#discussion_r1361630136
##########
docs/source/conf.py:
##########
@@ -288,6 +288,14 @@
# documentation.
#
+switcher_version = version
+if ".dev" in version:
+ switcher_version = "dev/"
+else:
+ # If we are not building dev version of the docs, we are building
+ # docs for the stable version
+ switcher_version = ""
Review Comment:
All in all, I would maybe just merge this PR as is, and then deal with the remaining issue discussed above to when we actually did a release, then it will be easier to experiment with this
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-38240: [Docs] version_match should match the version from versions.json [arrow]
Posted by "jorisvandenbossche (via GitHub)" <gi...@apache.org>.
jorisvandenbossche commented on code in PR #38241:
URL: https://github.com/apache/arrow/pull/38241#discussion_r1361625844
##########
docs/source/conf.py:
##########
@@ -288,6 +288,14 @@
# documentation.
#
+switcher_version = version
+if ".dev" in version:
+ switcher_version = "dev/"
+else:
+ # If we are not building dev version of the docs, we are building
+ # docs for the stable version
+ switcher_version = ""
Review Comment:
Although that would then give a duplicated entry in the dropdown, so also not ideal I suppose.
Another option would be to patch the doc sources when moving them from `/` to `/xx.x` when doing a release. It touches every file, but it's also a quite simple patch. A simple replacement of `DOCUMENTATION_OPTIONS.theme_switcher_version_match = '';` with the correct version.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-38240: [Docs] version_match should match the version from versions.json [arrow]
Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on PR #38241:
URL: https://github.com/apache/arrow/pull/38241#issuecomment-1759743283
@github-actions crossbow submit preview-docs
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-38240: [Docs] version_match should match the version from versions.json [arrow]
Posted by "jorisvandenbossche (via GitHub)" <gi...@apache.org>.
jorisvandenbossche commented on PR #38241:
URL: https://github.com/apache/arrow/pull/38241#issuecomment-1759739627
We cant' actually test this with the CI build, because there the link to the versions.json is wrong, and so the dropdown doesn't work anyway (maybe that's something else that we could also try to solve ..)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-38240: [Docs] version_match should match the version from versions.json [arrow]
Posted by "jorisvandenbossche (via GitHub)" <gi...@apache.org>.
jorisvandenbossche commented on code in PR #38241:
URL: https://github.com/apache/arrow/pull/38241#discussion_r1361680604
##########
docs/source/conf.py:
##########
@@ -312,8 +320,8 @@
],
"show_version_warning_banner": True,
"switcher": {
- "json_url": "/docs/_static/versions.json",
- "version_match": version,
+ "json_url": "https://arrow.apache.org/docs/_static/versions.json",
Review Comment:
OK, yes, let's leave this change then.
I think the main benefit is that it doesn't tie us to the exact base url (since it's always pointing relative to the root url), like if arrow.apache.org would change to something else. Which is quite unlikely on the short term, and even if it happens, it's also just a simple patch to the older doc built sources to replace `DOCUMENTATION_OPTIONS.theme_switcher_json_url = "...";`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-38240: [Docs] version_match should match the version from versions.json [arrow]
Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on code in PR #38241:
URL: https://github.com/apache/arrow/pull/38241#discussion_r1361684708
##########
docs/source/conf.py:
##########
@@ -312,8 +320,8 @@
],
"show_version_warning_banner": True,
"switcher": {
- "json_url": "/docs/_static/versions.json",
- "version_match": version,
+ "json_url": "https://arrow.apache.org/docs/_static/versions.json",
Review Comment:
> I think the main benefit is that it doesn't tie us to the exact base url (since it's always pointing relative to the root url), like if arrow.apache.org would change to something else. Which is quite unlikely on the short term, and even if it happens, it's also just a simple patch to the older doc built sources to replace `DOCUMENTATION_OPTIONS.theme_switcher_json_url = "...";`
Yes, I agree. We synced the work :D so the change for "json_url" is not added, but can be later if we see fit.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-38240: [Docs] version_match should match the version from versions.json [arrow]
Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on code in PR #38241:
URL: https://github.com/apache/arrow/pull/38241#discussion_r1361637838
##########
docs/source/conf.py:
##########
@@ -312,8 +320,8 @@
],
"show_version_warning_banner": True,
"switcher": {
- "json_url": "/docs/_static/versions.json",
- "version_match": version,
+ "json_url": "https://arrow.apache.org/docs/_static/versions.json",
Review Comment:
I do not mind changing back. It is much easier to test though. For anybody not knowing why the version_switcher is not working locally - and on the PR comment also.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-38240: [Docs] version_match should match the version from versions.json [arrow]
Posted by "jorisvandenbossche (via GitHub)" <gi...@apache.org>.
jorisvandenbossche commented on PR #38241:
URL: https://github.com/apache/arrow/pull/38241#issuecomment-1759754267
Actually, I tested it in the browser console by overriding that to the full json, and then running the js functions to update the dropdown, and at least for the dev version it is working nicely!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-38240: [Docs] version_match should match the version from versions.json [arrow]
Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on code in PR #38241:
URL: https://github.com/apache/arrow/pull/38241#discussion_r1361684708
##########
docs/source/conf.py:
##########
@@ -312,8 +320,8 @@
],
"show_version_warning_banner": True,
"switcher": {
- "json_url": "/docs/_static/versions.json",
- "version_match": version,
+ "json_url": "https://arrow.apache.org/docs/_static/versions.json",
Review Comment:
> I think the main benefit is that it doesn't tie us to the exact base url (since it's always pointing relative to the root url), like if arrow.apache.org would change to something else. Which is quite unlikely on the short term, and even if it happens, it's also just a simple patch to the older doc built sources to replace `DOCUMENTATION_OPTIONS.theme_switcher_json_url = "...";`
Yes, I agree. We synced the work so the change for "json_url" is not added, but can be later if we see fit.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-38240: [Docs] version_match should match the version from versions.json [arrow]
Posted by "jorisvandenbossche (via GitHub)" <gi...@apache.org>.
jorisvandenbossche commented on code in PR #38241:
URL: https://github.com/apache/arrow/pull/38241#discussion_r1361634338
##########
docs/source/conf.py:
##########
@@ -312,8 +320,8 @@
],
"show_version_warning_banner": True,
"switcher": {
- "json_url": "/docs/_static/versions.json",
- "version_match": version,
+ "json_url": "https://arrow.apache.org/docs/_static/versions.json",
Review Comment:
Do we want to keep this one as it was (that's in theory unrelated to the rest of this PR) ?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-38240: [Docs] version_match should match the version from versions.json [arrow]
Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on PR #38241:
URL: https://github.com/apache/arrow/pull/38241#issuecomment-1759740495
Yeah! Maybe use the full url path to arrow site?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-38240: [Docs] version_match should match the version from versions.json [arrow]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #38241:
URL: https://github.com/apache/arrow/pull/38241#issuecomment-1759747998
Revision: 461841cd0a682b2acf8353e8e9147a027ec26a1c
Submitted crossbow builds: [ursacomputing/crossbow @ actions-de0aa49a00](https://github.com/ursacomputing/crossbow/branches/all?query=actions-de0aa49a00)
|Task|Status|
|----|------|
|preview-docs|[](https://github.com/ursacomputing/crossbow/actions/runs/6497191837/job/17645728049)|
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-38240: [Docs] version_match should match the version from versions.json [arrow]
Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on code in PR #38241:
URL: https://github.com/apache/arrow/pull/38241#discussion_r1360295021
##########
docs/source/conf.py:
##########
@@ -288,6 +288,14 @@
# documentation.
#
+switcher_version = version
+if ".dev" in version:
+ switcher_version = "dev/"
+else:
+ # If we are not building dev version of the docs, we are building
+ # docs for the stable version
+ switcher_version = ""
Review Comment:
I think we will need to check for the numbered version of the docs here (13.0.0, 14.0.0, etc) and set the `switcher_version` to the number extracted from the version string (if not dev) so that once the docs get copied into the subdirectory will be correctly and equal to the version in the `versions.json`.
Then all the docs versions (old and dev), except stable, should have the correct text in the version switcher button. For the stable version - should we open a PR upstream to change the default text? 😊
##########
docs/source/conf.py:
##########
@@ -288,6 +288,14 @@
# documentation.
#
+switcher_version = version
+if ".dev" in version:
+ switcher_version = "dev/"
+else:
+ # If we are not building dev version of the docs, we are building
+ # docs for the stable version
+ switcher_version = ""
Review Comment:
I think we will need to check for the numbered version of the docs here (13.0.0, 14.0.0, etc) and set the `switcher_version` to the number extracted from the version string (if not dev) so that once the docs get copied into the subdirectory will be correctly and equal to the version in the `versions.json`.
Then all the docs versions (old and dev), except stable, should have the correct text in the version switcher button. For the stable version - should we open a PR upstream to change the default text? 😊
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-38240: [Docs] version_match should match the version from versions.json [arrow]
Posted by "jorisvandenbossche (via GitHub)" <gi...@apache.org>.
jorisvandenbossche commented on code in PR #38241:
URL: https://github.com/apache/arrow/pull/38241#discussion_r1361584270
##########
docs/source/conf.py:
##########
@@ -288,6 +288,14 @@
# documentation.
#
+switcher_version = version
+if ".dev" in version:
+ switcher_version = "dev/"
+else:
+ # If we are not building dev version of the docs, we are building
+ # docs for the stable version
+ switcher_version = ""
Review Comment:
Actually, can we just include both entries in the json file? Both one with "" for the old docs, and one with the actual version for the stable docs, so something like:
```
{
"name": "13.0 (stable)",
"version": "13.0.0/",
"url": "https://arrow.apache.org/docs/",
"preferred": true
},
{
"name": "13.0 (stable)",
"version": "",
"url": "https://arrow.apache.org/docs/",
},
```
?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-38240: [Docs] version_match should match the version from versions.json [arrow]
Posted by "jorisvandenbossche (via GitHub)" <gi...@apache.org>.
jorisvandenbossche commented on code in PR #38241:
URL: https://github.com/apache/arrow/pull/38241#discussion_r1361685585
##########
docs/source/conf.py:
##########
@@ -312,8 +320,8 @@
],
"show_version_warning_banner": True,
"switcher": {
- "json_url": "/docs/_static/versions.json",
- "version_match": version,
+ "json_url": "https://arrow.apache.org/docs/_static/versions.json",
Review Comment:
Ah, merged a few seconds too late to _not_ include your last commit ;)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-38240: [Docs] version_match should match the version from versions.json [arrow]
Posted by "conbench-apache-arrow[bot] (via GitHub)" <gi...@apache.org>.
conbench-apache-arrow[bot] commented on PR #38241:
URL: https://github.com/apache/arrow/pull/38241#issuecomment-1772045494
After merging your PR, Conbench analyzed the 5 benchmarking runs that have been run so far on merge-commit ecd38717077b57a81c7e569694876a787fb9d435.
There were no benchmark performance regressions. 🎉
The [full Conbench report](https://github.com/apache/arrow/runs/17885986894) has more details. It also includes information about 2 possible false positives for unstable benchmarks that are known to sometimes produce them.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-38240: [Docs] version_match should match the version from versions.json [arrow]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #38241:
URL: https://github.com/apache/arrow/pull/38241#issuecomment-1759375128
Revision: 11bc973db70f6b3fb87a22260d759dcb97d94e7e
Submitted crossbow builds: [ursacomputing/crossbow @ actions-2654a7ca0c](https://github.com/ursacomputing/crossbow/branches/all?query=actions-2654a7ca0c)
|Task|Status|
|----|------|
|preview-docs|[](https://github.com/ursacomputing/crossbow/actions/runs/6494638065/job/17637958765)|
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-37947: [Docs] version_match should match the version from versions.json [arrow]
Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on PR #38241:
URL: https://github.com/apache/arrow/pull/38241#issuecomment-1759370772
@github-actions crossbow submit preview-docs
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-38240: [Docs] version_match should match the version from versions.json [arrow]
Posted by "jorisvandenbossche (via GitHub)" <gi...@apache.org>.
jorisvandenbossche commented on code in PR #38241:
URL: https://github.com/apache/arrow/pull/38241#discussion_r1356940605
##########
docs/source/conf.py:
##########
@@ -288,6 +288,14 @@
# documentation.
#
+switcher_version = version
+if ".dev" in version:
+ switcher_version = "dev/"
+else:
+ # If we are not building dev version of the docs, we are building
+ # docs for the stable version
+ switcher_version = ""
Review Comment:
I just realize a potential problem with this .. We initially build the documentation as the stable docs for the release, but then afterwards we copy those those docs into a subdirectory to keep them as older docs, at which point they are not the "stable" docs anymore ...
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-38240: [Docs] version_match should match the version from versions.json [arrow]
Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on code in PR #38241:
URL: https://github.com/apache/arrow/pull/38241#discussion_r1356948444
##########
docs/source/conf.py:
##########
@@ -288,6 +288,14 @@
# documentation.
#
+switcher_version = version
+if ".dev" in version:
+ switcher_version = "dev/"
+else:
+ # If we are not building dev version of the docs, we are building
+ # docs for the stable version
+ switcher_version = ""
Review Comment:
Uh, I have been thinking about this today and am getting very confused =D
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-38240: [Docs] version_match should match the version from versions.json [arrow]
Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on code in PR #38241:
URL: https://github.com/apache/arrow/pull/38241#discussion_r1361679332
##########
docs/source/conf.py:
##########
@@ -312,8 +320,8 @@
],
"show_version_warning_banner": True,
"switcher": {
- "json_url": "/docs/_static/versions.json",
- "version_match": version,
+ "json_url": "https://arrow.apache.org/docs/_static/versions.json",
Review Comment:
Reverted the change: https://github.com/apache/arrow/pull/38241/commits/26a6561e144cfda2beec5724cc832a25dabde11c
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-38240: [Docs] version_match should match the version from versions.json [arrow]
Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on code in PR #38241:
URL: https://github.com/apache/arrow/pull/38241#discussion_r1361680626
##########
docs/source/conf.py:
##########
@@ -312,8 +320,8 @@
],
"show_version_warning_banner": True,
"switcher": {
- "json_url": "/docs/_static/versions.json",
- "version_match": version,
+ "json_url": "https://arrow.apache.org/docs/_static/versions.json",
Review Comment:
Can change the link of the "json_url" separately.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-38240: [Docs] version_match should match the version from versions.json [arrow]
Posted by "jorisvandenbossche (via GitHub)" <gi...@apache.org>.
jorisvandenbossche merged PR #38241:
URL: https://github.com/apache/arrow/pull/38241
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org