-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 Looks good - definitely the best of both worlds it looks like...
+1 for the Wiki option then ;) Cheers, Johan David Blevins wrote: > > On Jan 30, 2007, at 8:24 AM, Johan Lindquist wrote: > > A Wiki would probably be a better location for the docs for sure, but > the examples may be better off in the source tree to avoid typos that > prevent compilation etc. Also, by having it in source, you help the > user (re-)package the example should he want to try something on his own. > >> For the OpenEJB, we keep our samples in svn also. We've recently taken >> up using the Confluence snippet plugin to create sort of hybrid wiki/svn >> documentation. Here is an example example document :) > >> http://cwiki.apache.org/OPENEJB/embedded-and-remotable.html > >> Here's the wiki source for that doc: > >> http://cwiki.apache.org/confluence/pages/viewpagesrc.action?pageId=33261 > >> And here's some of the svn source for the doc: > > >> http://svn.apache.org/repos/asf/incubator/openejb/trunk/openejb3/examples/telephone-stateful/README.txt > > >> http://svn.apache.org/repos/asf/incubator/openejb/trunk/openejb3/examples/telephone-stateful/src/test/java/org/apache/openejb/examples/telephone/TelephoneTest.java > > >> Notice the "//START SNIPPET" "//END SNIPPET" comments in that second svn >> link. > >> I'm not sure yet if this approach is the best possible confluence/svn >> combination, but it seems to be working out so far. I don't like the >> "//START SNIPPET" comments in the source, but I can't argue with the >> results. > > >> -David > > > Johan > > Achim Hügen wrote: >>>> Btw: Apache projects can use a confluence wiki now for documentation >>>> purposes. >>>> The confluence support is not official yet but I requested a space >>>> and it's >>>> online already: http://cwiki.apache.org/HIVEMIND2/ >>>> The wiki pages get published to a static site periodically. >>>> >>>> IMHO the current way of documenting the different modules (core, lib, >>>> xml, jmx, annotations) >>>> leads to a very scattered documentation that lacks coherence and is >>>> updated seldom. >>>> I would suggest to reduce the documentation located inside the >>>> development >>>> environment: HiveDoc, JavaDoc should be generated and published >>>> automatically >>>> to the hivemind site, but all kind of tutorials, cookbooks, examples >>>> etc. should be edited in the wiki. >>>> >>>> Some projects practice that approach already and the results are quite >>>> impressive: >>>> >>>> http://cwiki.apache.org/OPENEJB/ >>>> http://cwiki.apache.org/WICKET/ >>>> >>>> What's your opinion? >>>> >>>> Achim >>>> >>>> >>>> James Carman schrieb: >>>>> That's what I mean. If you want an example of how to use Spring with >>>>> Hibernate, you can find that very quickly. Not so with HiveMind. >>>>> That's the kind of stuff we need. I thought about writing a HiveMind >>>>> Cookbook and having it published. >>>>> >>>>> >>>>> On 1/30/07, Paul Cooley <[EMAIL PROTECTED]> wrote: >>>>>> Just out of curiousity, what kind of real-world examples did your team >>>>>> expect/need to see? Perhaps examples that demonstrate the different >>>>>> service >>>>>> models (threaded, pooled, singleton, etc) as well as how to use the >>>>>> common >>>>>> framework services (BeanFactory, ChainBuilder, PipelineFactory, etc) >>>>>> would >>>>>> be very beneficial in addition to demonstrating how to use Hivemind in >>>>>> conjunction with common stacks (Torque, Hibernate, etc). >>>>>> >>>>>> >>>>>> On 1/30/07, James Carman <[EMAIL PROTECTED]> wrote: >>>>>>> All, >>>>>>> >>>>>>> I recently had a discussion with our project team at work about >>>>>>> adopting HiveMind. One of their biggest gripes was about our >>>>>>> documentation and examples or the lack thereof. I'd like to see >>>>>>> if we >>>>>>> can get some real-world examples out there that show the real >>>>>>> power of >>>>>>> HiveMind and how simple it can make your life. I've got some cool >>>>>>> Hibernate stuff that impresses people when they see it in action. >>>>>>> Since this stuff is based upon non-ASF licensed code, we'll have to >>>>>>> host it somewhere else (it's currently at JavaForge), but we can >>>>>>> always link to it from our site. Thoughts? We should definitely try >>>>>>> to HiveMind2.0ize it. >>>>>>> >>>>>>> James >>>>>>> >>>>>> >>>>>> >>>>>> >>>>>> --Gotta find my destiny, before it gets too late.-- Ian Curtis >>>>> >>>> >>>> > >> - -- you too? -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.6 (GNU/Linux) Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org iD8DBQFFwEu01Tv8wj7aQ34RAmWIAJ9SVApcfRGaeReMwk1sjwDKV9VrjACaAtaZ 0Gui2LgOBAQx7e57g1l+hPg= =8wrh -----END PGP SIGNATURE-----
