Skip to content
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

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

Merged

Conversation

AlenkaF
Copy link
Member

@AlenkaF AlenkaF commented Oct 12, 2023

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.

@AlenkaF
Copy link
Member Author

AlenkaF commented Oct 12, 2023

@github-actions crossbow submit preview-docs

@github-actions github-actions bot added the awaiting review Awaiting review label Oct 12, 2023
@AlenkaF AlenkaF changed the title GH-37947: [Docs] version_match should match the version from versions.json GH-38240: [Docs] version_match should match the version from versions.json Oct 12, 2023
@github-actions
Copy link

Revision: 11bc973

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

Task Status
preview-docs Github Actions

@jorisvandenbossche jorisvandenbossche added this to the 14.0.0 milestone Oct 12, 2023
@jorisvandenbossche
Copy link
Member

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
Copy link
Member Author

AlenkaF commented Oct 12, 2023

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

@AlenkaF
Copy link
Member Author

AlenkaF commented Oct 12, 2023

@github-actions crossbow submit preview-docs

@github-actions
Copy link

Revision: 461841c

Submitted crossbow builds: ursacomputing/crossbow @ actions-de0aa49a00

Task Status
preview-docs Github Actions

@jorisvandenbossche
Copy link
Member

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!

else:
# If we are not building dev version of the docs, we are building
# docs for the stable version
switcher_version = ""
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@github-actions github-actions bot added awaiting changes Awaiting changes and removed awaiting review Awaiting review labels Oct 12, 2023
@AlenkaF AlenkaF marked this pull request as ready for review October 17, 2023 07:29
@github-actions github-actions bot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Oct 17, 2023
@jorisvandenbossche jorisvandenbossche merged commit ecd3871 into apache:main Oct 17, 2023
9 checks passed
@jorisvandenbossche jorisvandenbossche removed the awaiting change review Awaiting change review label Oct 17, 2023
@github-actions github-actions bot added awaiting committer review Awaiting committer review awaiting changes Awaiting changes and removed awaiting committer review Awaiting committer review labels Oct 17, 2023
@AlenkaF AlenkaF deleted the gh-37947-version-switcher-version-match branch October 17, 2023 08:00
raulcd pushed a commit that referenced this pull request Oct 17, 2023
….json (#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.
* Closes: #38240

Authored-by: AlenkaF <frim.alenka@gmail.com>
Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
@conbench-apache-arrow
Copy link

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.

JerAguilon pushed a commit to JerAguilon/arrow that referenced this pull request Oct 23, 2023
…rsions.json (apache#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.
* Closes: apache#38240

Authored-by: AlenkaF <frim.alenka@gmail.com>
Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
loicalleyne pushed a commit to loicalleyne/arrow that referenced this pull request Nov 13, 2023
…rsions.json (apache#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.
* Closes: apache#38240

Authored-by: AlenkaF <frim.alenka@gmail.com>
Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
dgreiss pushed a commit to dgreiss/arrow that referenced this pull request Feb 19, 2024
…rsions.json (apache#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.
* Closes: apache#38240

Authored-by: AlenkaF <frim.alenka@gmail.com>
Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs] version_match should match the version from versions.json
2 participants