Re: Publishing of geode javadocs

2016-08-15 Thread Kirk Lund
Let's start out with external javadocs only. That way the focus is on the users of Geode. Sound good? -Kirk On Mon, Aug 15, 2016 at 3:57 PM, Mark Bretl wrote: > I can add 'geode-assembly/build/install/' to the archive step in the > nightly build or we could create a separate job, if necessary,

Re: Publishing of geode javadocs

2016-08-15 Thread Mark Bretl
I can add 'geode-assembly/build/install/' to the archive step in the nightly build or we could create a separate job, if necessary, to add the external javadocs. If we add the external javadocs to the current nightly build, the perma link would be https://builds.apache.org/job/Geode-nightly/lastSuc

Re: Publishing of geode javadocs

2016-08-14 Thread Udo Kohlmeyer
Maybe the review of the Javadoc for any class should be done as part of the final review of a story. Any public facing classes should be checked that the javadoc is correct for the affected classes. That the render correctly in the IDE, I think might be a side affect of making sure that they

Re: Publishing of geode javadocs

2016-08-12 Thread William Markito
+1 for that as well. Sent from my iPhone > On Aug 12, 2016, at 5:15 PM, Kirk Lund wrote: > > +1 I'd love to have this in place. What do others think? > > > On Fri, Aug 12, 2016 at 5:13 PM, Roman Shaposhnik > wrote: > >>> On Fri, Aug 12, 2016 at 4:51 PM, Dan Smith wrote: >>> I'm not sure

Re: Publishing of geode javadocs

2016-08-12 Thread Kirk Lund
+1 I'd love to have this in place. What do others think? On Fri, Aug 12, 2016 at 5:13 PM, Roman Shaposhnik wrote: > On Fri, Aug 12, 2016 at 4:51 PM, Dan Smith wrote: > > I'm not sure if we're publishing the nightly javadocs anywhere, but you > can > > build them from source. If you do a ./grad

Re: Publishing of geode javadocs

2016-08-12 Thread Roman Shaposhnik
On Fri, Aug 12, 2016 at 4:51 PM, Dan Smith wrote: > I'm not sure if we're publishing the nightly javadocs anywhere, but you can > build them from source. If you do a ./gradlew build, the external javadocs > are in geode-assembly/build/install/apache-geode/javadoc One solution that worked well for

Re: Publishing of geode javadocs

2016-08-12 Thread Kirk Lund
The javadocs on ConfigurationProperties look fine in the html generated by gradle, but it doesn't render properly in IntelliJ (some properties have javadocs that are fine but more complex ones are broken in the IDE). I think we should prefer having javadocs that are useful both in IDEs and as html

Re: Publishing of geode javadocs

2016-08-12 Thread Kirk Lund
We really need to find an automated solution for discovering javadoc errors earlier than manual inspection or looking for warnings in the gradle output. We change our build to fail on javadoc errors because it starts to fail due to 3rd party library javadocs, but at a minimum there must be some al

Re: Publishing of geode javadocs

2016-08-12 Thread Dan Smith
I'm not sure if we're publishing the nightly javadocs anywhere, but you can build them from source. If you do a ./gradlew build, the external javadocs are in geode-assembly/build/install/apache-geode/javadoc -Dan On Fri, Aug 12, 2016 at 4:31 PM, Kirk Lund wrote: > I can find the following from