Docs: Point links in metrics-reporting.md to GitHub Java source#10397
Conversation
|
@manuzhang How I read the doc is:
|
|
@manuzhang I see your comment in #10378. I don't think that the class being private is the underlying issue of the missing javadoc. For example, the RestCatalog doesn't have docs either: https://iceberg.apache.org/docs/javadoc/1.5.2/org/apache/iceberg/rest/RESTCatalog.html |
|
Hmm, the file is missing here: https://github.com/apache/iceberg/tree/javadoc/1.5.2/org/apache/iceberg/rest |
|
RESTCatalog has javadoc at https://github.com/apache/iceberg/blob/javadoc/1.5.2/org/apache/iceberg/rest/RESTCatalog.html. It looks another issue when deploying to website. |
|
Default level of generating javadoc is public and protected. |
|
If we don't intend to make |
|
@manuzhang I think that would make more sense, but I would love to get @nastra input here (he's currently on holiday). |
|
The |
|
The correct url is: https://iceberg.apache.org/javadoc/1.5.2/org/apache/iceberg/rest/RESTCatalog.html. Looks like the paths are not correct ( |
|
The URL in the |
Running the links checker from the CI turns out the be very flaky: apache#10397 Let's remove it for now: cc @manuzhang @pvary
….java Co-authored-by: Eduard Tudenhoefner <etudenhoefner@gmail.com>
Running the links checker from the CI turns out the be very flaky: apache#10397 Let's remove it for now: cc @manuzhang @pvary
Running the links checker from the CI turns out the be very flaky: #10397 Let's remove it for now: cc @manuzhang @pvary
Running the links checker from the CI turns out the be very flaky: apache#10397 Let's remove it for now: cc @manuzhang @pvary
Running the links checker from the CI turns out the be very flaky: apache#10397 Let's remove it for now: cc @manuzhang @pvary
Running the links checker from the CI turns out the be very flaky: apache#10397 Let's remove it for now: cc @manuzhang @pvary
It looks from the doc thatRESTMetricsReporteris available for users. However, it's not a public class. This PR makes it public and add some javadocs. It also fixes its javadoc missing issue.