On Sep 4, 2009, at 7:26 AM, Les Hazlewood wrote:
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?
The project needs to decide whether to publish the Maven-generated site as "The Shiro Site", or whether to use the confluence wiki as the official site.
The place to publish the result is http://incubator.apache.org/shiroLook at http://incubator.apache.org/ki/ for what is currently being done.
Once the project decides on the strategy for generating content, infrastructure can help with the mechanical details of automatically generating and pushing the site live.
Craig
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 thejavadocs by default). I already had a thread on this topic, see "Plansto 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 publishthe site, we could set up a Hudson job and then incrementally improve the contents. Kalle
Craig L Russell Architect, Sun Java Enterprise System http://db.apache.org/jdo 408 276-5638 mailto:[email protected] P.S. A good JDO? O, Gasp!
smime.p7s
Description: S/MIME cryptographic signature
