GH-38240: [Docs] version_match should match the version from versions.json

[AlenkaF]

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.

• Closes: [Docs] version_match should match the version from versions.json #38240

[AlenkaF]

@github-actions crossbow submit preview-docs

[github-actions]

Revision: 11bc973

Submitted crossbow builds: ursacomputing/crossbow @ actions-2654a7ca0c

Task	Status
preview-docs

[jorisvandenbossche]

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 ..)

[AlenkaF]

Yeah! Maybe use the full url path to arrow site?

[AlenkaF]

@github-actions crossbow submit preview-docs

[github-actions]

Revision: 461841c

Submitted crossbow builds: ursacomputing/crossbow @ actions-de0aa49a00

Task	Status
preview-docs

[jorisvandenbossche]

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!

[jorisvandenbossche]

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 ...

[AlenkaF]

Uh, I have been thinking about this today and am getting very confused =D

[AlenkaF]

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? 😊

[jorisvandenbossche]

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/",
},

?

[jorisvandenbossche]

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.

[AlenkaF]

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?

[jorisvandenbossche]

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

[conbench-apache-arrow]

After merging your PR, Conbench analyzed the 5 benchmarking runs that have been run so far on merge-commit ecd3871.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details. It also includes information about 2 possible false positives for unstable benchmarks that are known to sometimes produce them.

[AlenkaF]

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.

• Closes: [Docs] version_match should match the version from versions.json #38240

[AlenkaF]

@github-actions crossbow submit preview-docs

[github-actions]

Revision: 11bc973

Submitted crossbow builds: ursacomputing/crossbow @ actions-2654a7ca0c

Task	Status
preview-docs

[jorisvandenbossche]

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 ..)

[AlenkaF]

Yeah! Maybe use the full url path to arrow site?

[AlenkaF]

@github-actions crossbow submit preview-docs

[github-actions]

Revision: 461841c

Submitted crossbow builds: ursacomputing/crossbow @ actions-de0aa49a00

Task	Status
preview-docs

[jorisvandenbossche]

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!

[jorisvandenbossche]

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 ...

[AlenkaF]

Uh, I have been thinking about this today and am getting very confused =D

[AlenkaF]

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? 😊

[jorisvandenbossche]

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/",
},

?

[jorisvandenbossche]

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.

[AlenkaF]

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?

[jorisvandenbossche]

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

[conbench-apache-arrow]

After merging your PR, Conbench analyzed the 5 benchmarking runs that have been run so far on merge-commit ecd3871.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details. It also includes information about 2 possible false positives for unstable benchmarks that are known to sometimes produce them.

[AlenkaF]

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.

• Closes: [Docs] version_match should match the version from versions.json #38240

[AlenkaF]

@github-actions crossbow submit preview-docs

[github-actions]

Revision: 11bc973

Submitted crossbow builds: ursacomputing/crossbow @ actions-2654a7ca0c

Task	Status
preview-docs

[jorisvandenbossche]

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 ..)

[AlenkaF]

Yeah! Maybe use the full url path to arrow site?

[AlenkaF]

@github-actions crossbow submit preview-docs

[github-actions]

Revision: 461841c

Submitted crossbow builds: ursacomputing/crossbow @ actions-de0aa49a00

Task	Status
preview-docs

[jorisvandenbossche]

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!

[jorisvandenbossche]

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 ...

[AlenkaF]

Uh, I have been thinking about this today and am getting very confused =D

[AlenkaF]

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? 😊

[jorisvandenbossche]

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/",
},

?

[jorisvandenbossche]

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.

[AlenkaF]

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?

[jorisvandenbossche]

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

[conbench-apache-arrow]

After merging your PR, Conbench analyzed the 5 benchmarking runs that have been run so far on merge-commit ecd3871.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details. It also includes information about 2 possible false positives for unstable benchmarks that are known to sometimes produce them.

[AlenkaF]

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.

• Closes: [Docs] version_match should match the version from versions.json #38240

[AlenkaF]

@github-actions crossbow submit preview-docs

[github-actions]

Revision: 11bc973

Submitted crossbow builds: ursacomputing/crossbow @ actions-2654a7ca0c

Task	Status
preview-docs

[jorisvandenbossche]

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 ..)

[AlenkaF]

Yeah! Maybe use the full url path to arrow site?

[AlenkaF]

@github-actions crossbow submit preview-docs

[github-actions]

Revision: 461841c

Submitted crossbow builds: ursacomputing/crossbow @ actions-de0aa49a00

Task	Status
preview-docs

[jorisvandenbossche]

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!

[jorisvandenbossche]

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 ...

[AlenkaF]

Uh, I have been thinking about this today and am getting very confused =D

[AlenkaF]

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? 😊

[jorisvandenbossche]

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/",
},

?

[jorisvandenbossche]

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.

[AlenkaF]

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?

[jorisvandenbossche]

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

[conbench-apache-arrow]

After merging your PR, Conbench analyzed the 5 benchmarking runs that have been run so far on merge-commit ecd3871.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details. It also includes information about 2 possible false positives for unstable benchmarks that are known to sometimes produce them.

[AlenkaF]

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.

• Closes: [Docs] version_match should match the version from versions.json #38240

[AlenkaF]

@github-actions crossbow submit preview-docs

[github-actions]

Revision: 11bc973

Submitted crossbow builds: ursacomputing/crossbow @ actions-2654a7ca0c

Task	Status
preview-docs

[jorisvandenbossche]

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 ..)

[AlenkaF]

Yeah! Maybe use the full url path to arrow site?

[AlenkaF]

@github-actions crossbow submit preview-docs

[github-actions]

Revision: 461841c

Submitted crossbow builds: ursacomputing/crossbow @ actions-de0aa49a00

Task	Status
preview-docs

[jorisvandenbossche]

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!

[jorisvandenbossche]

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 ...

[AlenkaF]

Uh, I have been thinking about this today and am getting very confused =D

[AlenkaF]

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? 😊

[jorisvandenbossche]

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/",
},

?

[jorisvandenbossche]

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.

[AlenkaF]

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?

[jorisvandenbossche]

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

[conbench-apache-arrow]

After merging your PR, Conbench analyzed the 5 benchmarking runs that have been run so far on merge-commit ecd3871.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details. It also includes information about 2 possible false positives for unstable benchmarks that are known to sometimes produce them.

[AlenkaF]

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.

• Closes: [Docs] version_match should match the version from versions.json #38240

[AlenkaF]

@github-actions crossbow submit preview-docs

[github-actions]

Revision: 11bc973

Submitted crossbow builds: ursacomputing/crossbow @ actions-2654a7ca0c

Task	Status
preview-docs

[jorisvandenbossche]

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 ..)

[AlenkaF]

Yeah! Maybe use the full url path to arrow site?

[AlenkaF]

@github-actions crossbow submit preview-docs

[github-actions]

Revision: 461841c

Submitted crossbow builds: ursacomputing/crossbow @ actions-de0aa49a00

Task	Status
preview-docs

[jorisvandenbossche]

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!

[jorisvandenbossche]

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 ...

[AlenkaF]

Uh, I have been thinking about this today and am getting very confused =D

[AlenkaF]

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? 😊

[jorisvandenbossche]

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/",
},

?

[jorisvandenbossche]

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.

[AlenkaF]

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?

[jorisvandenbossche]

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

[conbench-apache-arrow]

After merging your PR, Conbench analyzed the 5 benchmarking runs that have been run so far on merge-commit ecd3871.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details. It also includes information about 2 possible false positives for unstable benchmarks that are known to sometimes produce them.

[AlenkaF]

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.

• Closes: [Docs] version_match should match the version from versions.json #38240

[AlenkaF]

@github-actions crossbow submit preview-docs

[github-actions]

Revision: 11bc973

Submitted crossbow builds: ursacomputing/crossbow @ actions-2654a7ca0c

Task	Status
preview-docs

[jorisvandenbossche]

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 ..)

[AlenkaF]

Yeah! Maybe use the full url path to arrow site?

[AlenkaF]

@github-actions crossbow submit preview-docs

[github-actions]

Revision: 461841c

Submitted crossbow builds: ursacomputing/crossbow @ actions-de0aa49a00

Task	Status
preview-docs

[jorisvandenbossche]

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!

[jorisvandenbossche]

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 ...

[AlenkaF]

Uh, I have been thinking about this today and am getting very confused =D

[AlenkaF]

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? 😊

[jorisvandenbossche]

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/",
},

?

[jorisvandenbossche]

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.

[AlenkaF]

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?

[jorisvandenbossche]

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

[conbench-apache-arrow]

After merging your PR, Conbench analyzed the 5 benchmarking runs that have been run so far on merge-commit ecd3871.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details. It also includes information about 2 possible false positives for unstable benchmarks that are known to sometimes produce them.

[AlenkaF]

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.

• Closes: [Docs] version_match should match the version from versions.json #38240

[AlenkaF]

@github-actions crossbow submit preview-docs

[github-actions]

Revision: 11bc973

Submitted crossbow builds: ursacomputing/crossbow @ actions-2654a7ca0c

Task	Status
preview-docs

[jorisvandenbossche]

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 ..)

[AlenkaF]

Yeah! Maybe use the full url path to arrow site?

[AlenkaF]

@github-actions crossbow submit preview-docs

[github-actions]

Revision: 461841c

Submitted crossbow builds: ursacomputing/crossbow @ actions-de0aa49a00

Task	Status
preview-docs

[jorisvandenbossche]

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!

[jorisvandenbossche]

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 ...

[AlenkaF]

Uh, I have been thinking about this today and am getting very confused =D

[AlenkaF]

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? 😊

[jorisvandenbossche]

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/",
},

?

[jorisvandenbossche]

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.

[AlenkaF]

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?

[jorisvandenbossche]

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

[conbench-apache-arrow]

After merging your PR, Conbench analyzed the 5 benchmarking runs that have been run so far on merge-commit ecd3871.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details. It also includes information about 2 possible false positives for unstable benchmarks that are known to sometimes produce them.