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][Java] Link to Arrow Flight SQL API documentation is broken #45404

Open
linghengqian opened this issue Feb 1, 2025 · 4 comments
Open

Comments

@linghengqian
Copy link
Member

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

Component(s)

Website

@kou kou changed the title Link to Arrow Flight SQL API documentation is broken [Docs][Java] Link to Arrow Flight SQL API documentation is broken Feb 1, 2025
@kou
Copy link
Member

kou commented Feb 1, 2025

Ah, this is caused by apache/arrow -> apache/arrow-java separation.

It should be https://arrow.apache.org/java/current/reference/org.apache.arrow.flight.sql/org/apache/arrow/flight/sql/package-summary.html when we release 18.1.0 from apache/arrow-java. See also: apache/arrow-java#574

@lidavidm BTW, it seems that old Javadoc URL is https://.../org/apache/arrow/... (separated by / not .) not https://.../org.apache.arrow.../ (separated by . not /). Should we use / separator for apache/arrow-java docs?

@lidavidm
Copy link
Member

lidavidm commented Feb 2, 2025

Hmm. AFAIK we just use whatever Javadoc gives us. If it changed, maybe we want to change it back somehow (maybe with .htaccess if it supports patterns?) Or redirect old to new, actually

@kou
Copy link
Member

kou commented Feb 2, 2025

Hmm. It seems that old URL was
https://.../org.apache.arrow.XXX/org/apache/arrow/XXX/...
not
https://.../org/apache/arrow/...

It's same as the new URL pattern.

See: https://github.com/apache/arrow-site/blob/13c3daeb06e55b65b5ce281217289b5625dce9b9/docs/java/reference/org.apache.arrow.flight.sql/org/apache/arrow/flight/sql/package-summary.html

Anyway, we can add a .htaccess configuration for https://arrow.apache.org/docs/java/ -> https://arrow.apache.org/java/current/ redirect.

@kou
Copy link
Member

kou commented Feb 2, 2025

Oh, 18.0.0 uses https://.../org.apache.arrow.XXX/org/apache/arrow/XXX/... and 17.0.0 uses https://.../org/apache/arrow/XXX/...

See: https://github.com/apache/arrow-site/tree/45046999f7e199ece2718aa52f9cd4000852ee5a/docs/java/reference

It seems that Javadoc changed the default format.

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

3 participants