But I don't want to have to get onto the website to read the docs. I want the docs to be downloaded with the distribution and I want them to be in a single document that I can read through by scrolling instead of clicking links. Clicking links is *NOT* a satisfying experience.
Wiki's are good for things like alternative tutorials, "Hey Look What I Did" stories, FAQ's that are regularly updated, etc. They are not good for the primary product documentation. rjsjr > -----Original Message----- > From: Vikas Phonsa [mailto:[EMAIL PROTECTED] > Sent: Wednesday, March 03, 2004 10:58 AM > To: 'Avalon framework users' > Subject: RE: PowerPoint presentation > > > Well I'm impressed by the cocoon wiki, if that's what its > gonna be then its > fine. I don't know and care abt how wiki works or whatever, > all I and most > other users would care about is to find all the information > in an easy to > read, reasonably pretty (like the cocoon wiki)and organized > location on the > web. > > Vikas > > > > -----Original Message----- > From: Leo Simons [mailto:[EMAIL PROTECTED] > Sent: Tuesday, March 02, 2004 11:52 PM > To: [EMAIL PROTECTED] > Subject: Re: PowerPoint presentation > > boy, we really should change some perceptions about wikis here :D > > Including an image in a wiki is as simple as specifying its > URL. It is > way easier to create a diagram and put it on our wiki than to > create a > diagram and put it on our website. Alternatively, you can upload an > image and attach it to the wiki page by typing > 'attachment:someimage.gif' in the page 'source'. The same > goes for other > kinds of content. > > As an example of a project that has successfully used a wiki > to improve > its documentation, take a look at cocoon. Their docs used to be worse > than avalon's, which changed quite quickly after setting up > their wiki: > > http://wiki.cocoondev.org/Wiki.jsp > > Another famous example of a project that has "Edit this page" > functionality for its entire website is mozilla: > > http://doctor.mozilla.org/ > > Pawel X Karendys wrote: > > I think you need to be careful placing too much weight on > the Wiki. It > > forces one to do more-or-less text-based documentation and, > as you all > > know, Avalon's documentation can not be called > "diagram-rich". ;) To me, > > Wiki should be treated only as a pre-documenation > stage/container for hot > > thoughts and ideas before the real thing is going to be produced. > > to me, wikis are the content management system idea "done > right". Easy > web-based editing, seperation of content from presentation, and > evolvable in every possible direction. > > For example, have you had experience actually using a wiki > internal to > your organisation? It has helped one or two projects I was > involved with > tremendously. > > If apache is a company, and avalon a division, the wiki is our open > collaboration space (CVS, on the other hand, is closed). > > > People > > should be able to read/download a comprehensive documentation that > > explains concepts using diagrams supported by reasonable > good explanation. > > that is the goal. Totally agreed. Additional goals include up-to-date > documentation, well-structructured documentation, objective > documentation, etc etc. But I really can't see why an "edit > this page" > link gets in the way of that :-D > > -- > cheers, > > - Leo Simons > > -------------------------------------------------------------- > --------- > Weblog -- http://leosimons.com/ > IoC Component Glue -- http://jicarilla.org/ > Articles & Opinions -- http://articles.leosimons.com/ > -------------------------------------------------------------- > --------- > "We started off trying to set up a small anarchist community, but > people wouldn't obey the rules." > -- > Alan Bennett > > > > --------------------------------------------------------------------- > To unsubscribe, e-mail: [EMAIL PROTECTED] > For additional commands, e-mail: [EMAIL PROTECTED] > > --------------------------------------------------------------------- > To unsubscribe, e-mail: [EMAIL PROTECTED] > For additional commands, e-mail: [EMAIL PROTECTED] > --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
