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

[Docs][Website] https://arrow.apache.org/docs/16.0/ doesn't exist #44568

Closed
kou opened this issue Oct 30, 2024 · 7 comments
Closed

[Docs][Website] https://arrow.apache.org/docs/16.0/ doesn't exist #44568

kou opened this issue Oct 30, 2024 · 7 comments

Comments

@kou
Copy link
Member

kou commented Oct 30, 2024

Describe the bug, including details regarding any error messages, version, and platform.

But our version list includes it:

{
"name": "16.0",
"version": "16.0/",
"url": "https://arrow.apache.org/docs/16.0/"
},

Should we remove the entry or create https://arrow.apache.org/docs/16.0/ ?

Component(s)

Documentation, Website

@amoeba
Copy link
Member

amoeba commented Oct 30, 2024

Thanks for catching this. I think we should create it. Even though, for this specific release, it's probably of minimal practical value, it's best that every release have a match docset. I notice we don't have a built copy at https://apache.jfrog.io/ui/native/arrow/docs/ any longer. Is it better to create it by hand or use one of the CI tasks we already use to create it?

@kou
Copy link
Member Author

kou commented Oct 30, 2024

OK. I've restored https://apache.jfrog.io/ui/native/arrow/docs/16.0.0/ .
(I removed it because of our Artifactory space quota...)

@amoeba
Copy link
Member

amoeba commented Oct 30, 2024

Nice. I suppose it's fine to remove it and even more recent versions like 16.1.0 once we're done here since the arrow-site repo has near-1:1 copies of the content. Let me know if you'd like me to create a PR for this. I think it should just require downloading the artifact and applying our version banner changes in post-10-docs.sh manually, right?

@kou
Copy link
Member Author

kou commented Oct 30, 2024

Right. Could you work on this?

@amoeba amoeba self-assigned this Oct 30, 2024
@amoeba
Copy link
Member

amoeba commented Oct 30, 2024

I assigned myself and will start on this tomorrow. Thanks for all the help so far.

@amoeba
Copy link
Member

amoeba commented Oct 31, 2024

I put up a PR for this if you want to take a look @kou: apache/arrow-site#555

kou pushed a commit to apache/arrow-site that referenced this issue Oct 31, 2024
To create this PR I:

1. Downloaded the 16.0 archive from
https://apache.jfrog.io/ui/native/arrow/docs/16.0.0/, verified the
sha512, expanded into a temp directory
3. Ran slightly modified commands from post-10-docs.sh to update the
version banner appropriately:
  - delete `java/reference` which we do in the script
- `find . -type f -exec sed -i.bak -e
"s/DOCUMENTATION_OPTIONS.theme_switcher_version_match =
'';/DOCUMENTATION_OPTIONS.theme_switcher_version_match = '16.0';/g" -e
"s/DOCUMENTATION_OPTIONS.show_version_warning_banner =
false/DOCUMENTATION_OPTIONS.show_version_warning_banner = true/g" {} \;`
  - `find ./ -name '*.bak' -delete`
5. Verified things looked good locally, particularly the version banner
works. See Screenshot (below)
6. Put up this PR with the result

<details>
<summary>Screenshot</summary>

![Screenshot from 2024-10-30
17-00-15](https://github.com/user-attachments/assets/79e15047-f824-4d62-b604-ec0b6a5ac49f)
</details>

Closes apache/arrow#44568
@kou
Copy link
Member Author

kou commented Oct 31, 2024

Done by apache/arrow-site#555 .

@kou kou closed this as completed Oct 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants