I wonder if apache infra have anything for this? Tim
Sent from my iPhone > On Aug 6, 2014, at 6:41 PM, Niklas Nielsen <[email protected]> wrote: > > Cool! > > I will try to look into how to host this if there are no objections by EOD > tomorrow. > > Dave, do you know the next steps / a good place where we could do this? > > Cheers, > Niklas > > >> On Wed, Aug 6, 2014 at 6:29 PM, Adam Bordelon <[email protected]> wrote: >> >> +1 on comments on public classes/methods >> +1 on auto-generating and hosting doxygen (on ASF or mesosphere or >> wherever) >> I don't care what annotation style we use, as long as we're consistent >> >> >>> On Wed, Aug 6, 2014 at 5:18 PM, Julien Eid <[email protected]> wrote: >>> >>> +1 >>> >>> It would be great to also host the /help endpoint and also document all >> the >>> endpoints in it. >>> >>> >>>> On Wed, Aug 6, 2014 at 5:05 PM, Vinod Kone <[email protected]> wrote: >>>> >>>> +1 >>>> >>>> >>>>> On Wed, Aug 6, 2014 at 4:32 PM, Niklas Nielsen <[email protected]> wrote: >>>>> >>>>> Hi guys, >>>>> >>>>> I think it is in communities interest to lower the barrier to entry >> for >>>> new >>>>> contributors to the project. Not only in terms of process (as BenH >> has >>>> been >>>>> putting a lot of effort into - bravo!) but also in terms of making it >>>>> easier to understand the inner workings of Mesos. >>>>> So far, it is more or less "Go look at the implementation" approach >> or >>>>> having Mesos developers explain the details on the mailing lists to >> get >>>>> deeper than the design discussions we have on JIRA or the few >>>>> subsystem/architecture docs we have on wiki and in docs/. >>>>> Not that this is a bad thing, but I think we could do a better job in >>>>> codifying it a bit - one step could be to make source browsing and >>>>> documentation generation (such as doxygen - I am not religious about >>>> that) >>>>> in place. >>>>> >>>>> If this is already on-going and hosted, let me know and I'll try to >> do >>> a >>>>> better job staying informed. If not, how about starting a >> conversation >>>> on: >>>>> >>>>> 1) A style of doxygen annotations we can agree on (We have a Doxyfile >>>>> already in the repo) >>>>> 2) Start encouraging incoming patches to comment on public classes, >>>> methods >>>>> and variables >>>>> 3) Start automating generation of those and host it, like we host the >>>>> Javadoc at http://mesos.apache.org/api/latest/ >>>>> >>>>> Thoughts? >>>>> >>>>> Cheers, >>>>> Niklas > > > > -- > Niklas
