Re: [hibernate-dev] Tutorials

2010-08-29 Thread Hardy Ferentschik
Looks ok to me. How do you want to refer to the classes in the tutorials? An plans to keep the docs in sync with the actual test code? Didn't you mention once Christian's AuthorDoclet. Have you investigated whether it could help here? --Hardy On Sat, 28 Aug 2010 02:23:04 +0200, Steve Ebersol

Re: [hibernate-dev] Tutorials

2010-08-27 Thread Steve Ebersole
So I worked on this approach today. http://anonsvn.jboss.org/repos/hibernate/core/trunk/documentation/quickstart/ This is the root source directory for the "Getting Started Guide" (its a pom of type "jdocbook"). Under it is a "tutorials" directory which defines a (unrelated) multi-module maven

Re: [hibernate-dev] Tutorials

2010-08-27 Thread Steve Ebersole
I guess my concern here is mostly the lack of cohesion. So we'd be discussing stuff in a web page opened in the users browser, referencing source code that is open in their IDE. I guess everything else is just technical details. Bottom line is whether we think this is easier for users or less.

Re: [hibernate-dev] Tutorials

2010-08-27 Thread Steve Ebersole
On Fri, 2010-08-27 at 10:50 +0200, Hardy Ferentschik wrote: > I also like the idea of externalizing the docs. > > Have you thought about building maven archetypes? Not sure whether this > would be possible with gradle though. > Besides the archetype plugin sucks. Thought about it? Sure. My "i

Re: [hibernate-dev] Tutorials

2010-08-27 Thread Hardy Ferentschik
I also like the idea of externalizing the docs. Have you thought about building maven archetypes? Not sure whether this would be possible with gradle though. Besides the archetype plugin sucks. Regarding the versions. Wouldn't you you some sort of filtering during build time? --Hardy On Th

Re: [hibernate-dev] Tutorials

2010-08-26 Thread Steve Ebersole
Another worry is "linking" these with versions without hardcoding the urls etc. Especially artifact versions inside the poms in the zip. On Thu, 2010-08-26 at 21:15 +0200, Emmanuel Bernard wrote: > The CaveatEmptor app was doing that. I think it's a good idea. Christian told > be it was quite po

Re: [hibernate-dev] Tutorials

2010-08-26 Thread Emmanuel Bernard
The CaveatEmptor app was doing that. I think it's a good idea. Christian told be it was quite popular. That being said, I think the getting started guide explaining the tutorial should keep an embedded copy of the sources (at least partial - showing the code on the focused feature) to show peop

[hibernate-dev] Tutorials

2010-08-26 Thread Steve Ebersole
http://opensource.atlassian.com/projects/hibernate/browse/HHH-5441 There was a suggestion to externalize all the tutorial source into a separate zip to make it even easier to get started. So as a user I'd be able to download the tutorials.zip (with or without the "getting started guide"), extract