Re: Require projects to have solid API docs

2015-10-12 Thread Greg Stein
On Sun, Oct 11, 2015 at 11:20 PM, Julian Hyde wrote: > On Sun, Oct 11, 2015 at 1:11 PM, Alan D. Cabrera > wrote: > > Should != Must > > Yes, I know. But I didn't want to have everyone leap into yet another > long-winded debate with no one even having

Re: Require projects to have solid API docs

2015-10-12 Thread Emmanuel Lécharny
Le 11/10/15 17:59, Andrew Pennebaker a écrit : > In the future, could Apache Incubator require projects to maintain better > API documentation before graduation? In particular, Kafka has rather sparse > documentation in v0.8. The Javadocs appear to be randomly hosted on this or > that professor

Re: Require projects to have solid API docs

2015-10-11 Thread Julian Hyde
Per [1], "Apache projects should provide sufficient documentation [… so that … ] users can both make use of our software freely”. And: "users of Apache software should be able to find our software, learn how to use it, and actually apply it to all its common use cases solely by going to the

Re: Require projects to have solid API docs

2015-10-11 Thread Luciano Resende
On Sun, Oct 11, 2015 at 9:15 AM, Ross Gardler wrote: > No. That’s not the role of the foundation. However, ensuring people > contributing to the docs are recognized like any other contributor is the > role of the foundation. Can you help contribute to such docs? > > >

RE: Require projects to have solid API docs

2015-10-11 Thread Ross Gardler
No. That’s not the role of the foundation. However, ensuring people contributing to the docs are recognized like any other contributor is the role of the foundation. Can you help contribute to such docs? Sent from Outlook Mail for Windows 10

Re: Require projects to have solid API docs

2015-10-11 Thread Mark Thomas
On 11/10/2015 16:59, Andrew Pennebaker wrote: > In the future, could Apache Incubator require projects to maintain better > API documentation before graduation? In particular, Kafka has rather sparse > documentation in v0.8. The Javadocs appear to be randomly hosted on this or > that professor

Re: Require projects to have solid API docs

2015-10-11 Thread Alan D. Cabrera
Should != Must Regards, Alan > On Oct 11, 2015, at 11:49 AM, Julian Hyde wrote: > > Per [1], "Apache projects should provide sufficient documentation [… so that > … ] users can both make use of our software freely”. > > And: "users of Apache software should be able to find

Re: Require projects to have solid API docs

2015-10-11 Thread Julian Hyde
On Sun, Oct 11, 2015 at 1:11 PM, Alan D. Cabrera wrote: > Should != Must Yes, I know. But I didn't want to have everyone leap into yet another long-winded debate with no one even having mentioned that there is existing policy on this matter. Julian

Re: Require projects to have solid API docs

2015-10-11 Thread Alan D. Cabrera
> On Oct 11, 2015, at 9:20 PM, Julian Hyde wrote: > > On Sun, Oct 11, 2015 at 1:11 PM, Alan D. Cabrera wrote: >> Should != Must > > Yes, I know. But I didn't want to have everyone leap into yet another > long-winded debate with no one even having

Re: Require projects to have solid API docs

2015-10-11 Thread Joe Stein
The Apache Kafka javadoc and scala doc are published with source and binaries https://archive.apache.org/dist/kafka/0.8.2.2/ and they can be generated from source. There is no javadoc for both producer and consumer (yet but you can generate from trunk for 0.9) because the new java consumer has