search

apache / iceberg

Apache Iceberg
https://iceberg.apache.org/
Apache License 2.0
5.96k stars 2.09k forks source link

Javadoc issues #10378

Open manuzhang opened 2 months ago

manuzhang commented 2 months ago

Apache Iceberg version

main (development)

Query engine

None

Please describe the bug 🐞

There are several issues with Javadoc

  1. https://iceberg.apache.org/javadoc/nightly is not found
  2. Links in https://iceberg.apache.org/docs/1.4.3/metrics-reporting points to 1.5.2 Javadoc
  3. https://iceberg.apache.org/docs/javadoc/1.5.2/org/apache/iceberg/rest/RESTMetricsReporter.html is missing (fixed in https://github.com/apache/iceberg/pull/10397)
jbonofre commented 1 month ago

Good catch @manuzhang ! Let me fix that on the website.

manuzhang commented 1 month ago

@jbonofre Are you working on all these issues?

jbonofre commented 1 month ago

I didn't start yet. Up to you. I can start on it tonight or you can take it.

Fokko commented 1 month ago

Thanks for caching these @manuzhang. Let me know if you need any help!

manuzhang commented 1 month ago

Submitted https://github.com/apache/iceberg/pull/10397 for No. 3.

Fokko commented 1 month ago

https://iceberg.apache.org/javadoc/nightly is not found

It looks like the nightly points to latest according to https://github.com/apache/iceberg/tree/main/site#building-the-versioned-docs

manuzhang commented 1 month ago

It looks like the nightly points to latest according to https://github.com/apache/iceberg/tree/main/site#building-the-versioned-docs

It's documented but not actually implemented.

Fokko commented 1 month ago

Links in https://iceberg.apache.org/docs/1.4.3/metrics-reporting points to 1.5.2 Javadoc

That one is quite tricky. It looks like it uses the macro plugin to set the version. The problem is that the macro plugin doesn't work well with the monorepo plugin. There is no way to override the version. I think the easiest way to fix this is to change the directory structure from:

docs/1.4.3/
javadoc/1.4.3/

to:

1.4.3/docs/
1.4.3/javadoc/

This way we can make relative links. I can play around with this tomorrow

Fokko commented 1 week ago

I'll bump this to 1.7.0. It would be best if we could fix this using the macro plugin in combination with the monorepo plugin: https://github.com/backstage/mkdocs-monorepo-plugin/issues/130

jbonofre commented 1 week ago

@Fokko thanks ! It makes sense. I will take a look on this one for 1.7.0 (definitely not a blocker for 1.6.0).