Sure, I think that's a good idea. Mentors - where can this site be hosted and how do we automate the push to that location?
Thanks, Les On Fri, Sep 4, 2009 at 10:17 AM, Kalle Korhonen <[email protected]> wrote: > On Fri, Sep 4, 2009 at 12:23 AM, Salazar, > Alexander<[email protected]> wrote: >> Even though a 1.0 has not yet been released, I think it would be helpful to >> get to-date Shiro API documentation online and available. >> According to Les, "Maven auto-generates not just the API documentation, but >> an entire site. However, we've only been using the wiki thus far. We would >> have to get the auto-export of this generated documentation set up based on >> the automated build process." >> >> What would be the best way to go about this? Do you agree that it would be >> valuable prior to the 1.0 release? > > The best way would be to publish the Maven site (it includes the > javadocs by default). I already had a thread on this topic, see "Plans > to publish javadocs & Maven site continuously/nightly?". The question > Les had whether there were any guidelines regarding publishing the > documentation while a project is still in incubator but no responses > (though I know at least CXF was publishing all docs while in incubator > so I don't think it's an issue). Once we know *where* we could publish > the site, we could set up a Hudson job and then incrementally improve > the contents. > > Kalle >
