beam-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Davor Bonaci (JIRA)" <>
Subject [jira] [Commented] (BEAM-1175) Separate runners-core Javadoc from SDK Javadoc, and perhaps other artifacts
Date Thu, 09 Mar 2017 18:22:38 GMT


Davor Bonaci commented on BEAM-1175:

I believe we have recently removed runner-facing Javadoc from being published for each release.
Now, the published Javadoc should include only user facing things. (To became visible with
the next release). I think this addresses the first part of this issue.

The second part is about making runner-facing Javadoc published. That is available on a per-module
basis in Maven Central, and automatically integrated into some tooling. Not sure we need to
publish it on the website just yet.

So, 1/2 is done, the other half can be deferred, I think. Resolving. Perhaps reopen if you
think we need to address this in the near future.

> Separate runners-core Javadoc from SDK Javadoc, and perhaps other artifacts
> ---------------------------------------------------------------------------
>                 Key: BEAM-1175
>                 URL:
>             Project: Beam
>          Issue Type: Bug
>          Components: website
>            Reporter: Kenneth Knowles
>            Assignee: James Malone
>             Fix For: Not applicable
> Currently, the runners-core Javadoc is included with the SDK's Javadoc on the website.
> Pipeline authors should only be viewing the SDK's Javadoc, and likely the IOs.
> Generally, while I do think we can't really separate every IO Javadoc, it is extremely
confusing to have Javadoc for separate POM dependencies included together, since the classes
listed will not actually be available to someone who just depends on the SDK.

This message was sent by Atlassian JIRA

View raw message