Raphael Luta wrote: > -----Original Message----- > From: [EMAIL PROTECTED] > [mailto:[EMAIL PROTECTED]]On Behalf Of > [EMAIL PROTECTED] > Sent: Monday, December 18, 2000 1:12 AM > To: JetSpeed > Subject: Re: docs > > > [forwarded to the mailing-list] > > David Sean Taylor wrote: > > > > Raphael, > > > > Here are the documentation tasks Im working on. > > Im also thinking that we need to document the new template > support that you > > have done. > > Do you have any docs, proposals describing the templating system? > > > > It's not committed yet and won't be part of the 1.3a1 release. > > > Im concentrating on converting my Developers Guide to 1.3a1. I > think I can > > finish it tomorrow along with > > the top tasks below 'Working documents' > > > > Also think we should regenerate the javadocs and put them on > the website. > > > > I agree. Should we also put them in the webapp ? > Of course the javadocs can always be built with one easy command. Its a question of do we want to make the war bigger versus the trade off of having the javadocs immediately available with the war file. I think that the javadocs should go into the webapp, since the webapp is really a starting point for people to start using the system and learn about it. > BTW, how did you plan to organize the documentation ? > I think we have 3 kinds of documents : > - General features presentation > - User documentation, ie documentation targetted at people non involved > in Jetspeed community but who want to use the software > - Developer documentation, documentation for the existing developpers or > those wishing to join the project > > It would be good if all documents of the same kind were grouped > together in > the site-book. > Yes agreed. We have done exactly that. > > > ------------------------------------------------------------------ > ---------- > > Working documents > > > ------------------------------------------------------------------ > ---------- > > Overview - index.xml - in progress > > OK. I probably will add a little paragraph on the overview when you're > done. > > > Features - features.xml - in progress > > Site-book - sitebook.xml - in progress > > Installation - install.xml - done > > > Administration - administration.xml - *** are we still > supporting the admin > > screens? > > We will always need an administration feature even though the > administration > screen is likely to change soon. For this release, I think we > should keep it > as is. > Is the administration going to be working in 1.3a1? If so, what do you mean by changing and how soon? Is it changing for 1.3a1? > > Applications- - applications- - im replacing a lot of > this with the > > Jetspeed Dev. Guide > > Development development.xml > > > > Good > > > Content- - content-syndication.xml - *** > this would be useful to have. > > Syndication > > > > It's necessary. If you don't know what to write on this, I can > take care of it > I will give it a try.... > > Customizer - Customizer.xml - not > started, but I think its pretty simple > > to document > > > > Maybe ingo or thomas can do it > This is pretty simple since Im doc'ing it in the 'User documentation' seciton > > DiskCache - diskcache.xml - *** Im really > not sure how it works now, can > > use some help > > > > Santiago is probably the best guy to update this document. > > > FAQ - faq.xml - *** > There aren't many FAQs. We should pool together > > everyone's > > experiences > > > > Agreed. > > > iCalendar - iCalendar.xml - *** Im not > sure if this works. Never tried it. > > It's now more or less a separate project which was supposed to > move to jakarata > but it's not done yet AFAIK. Jeff can you update the iCalendar page ? > > > PSML - psml.xml - In > progress. IBM is providing some docs > > > > Good. > > > > ------------------------------------------------------------------ > ---------- > > --------------------------------- > > Im not sure if you want all this in the Sitebook or not. I can > clean it up, > > but is it all necessary? > > > ------------------------------------------------------------------ > ---------- > > --------------------------------- > > Branches - branches.xml - *** Is this > needed in the sitebook? > > Code Standards - code-standards.xml - *** Is this needed in > the sitebook? > > Contributors - contributors.xml - *** Is this needed in > the sitebook? > > License - license.xml - *** Is this needed in > the sitebook? > > Developer-Notes - developer-notes.xml - *** Is this needed in the > > Todo - todo.xml - *** > Is this needed in the sitebook? > > We should keep these. They are developer resources. > > > Resources - resources.xml - *** Is this > needed in the sitebook? > > Yes. This is just a link page > > > UML - uml.xml - *** > Is this needed in the sitebook? > > If nobody can come with an updated UML diagram, I propose that we > remove it for > now. > > > UseJetspeed? - usejetspeed.xml - *** Is this > needed in the sitebook? > > relativity.org seems down and I'm not aware of any other public > Jetspeed server so I > that we should better remove it for now. > > > WAP - wap.xml - *** > Is this needed in the sitebook? > > > > This need to be updated and maybe integrated in the "Features" > > > > ------------------------------------------------------------------ > ---------- > > These features need to be documented/published, but they aren't > complete so > > they can wait til next release > > > ------------------------------------------------------------------ > ---------- > > - Persistence Service - *** is this actually tested > and working right now? > > - Portlet API - leave this out til next time > > - Profiler - *** I have docs on this, but > will the feature be included? > > > ------------------------------------------------------------------ > ---------- > > I agree. I don't believe we have time for writing this up anyway. > > -- > Rapha�l Luta - [EMAIL PROTECTED] > Vivendi Universal Networks - Services Manager / Paris > > > -- > -------------------------------------------------------------- > Please read the FAQ! <http://java.apache.org/faq/> > To subscribe: [EMAIL PROTECTED] > To unsubscribe: [EMAIL PROTECTED] > Archives and Other: <http://marc.theaimsgroup.com/?l=jetspeed> > Problems?: [EMAIL PROTECTED] > > -- -------------------------------------------------------------- Please read the FAQ! <http://java.apache.org/faq/> To subscribe: [EMAIL PROTECTED] To unsubscribe: [EMAIL PROTECTED] Archives and Other: <http://marc.theaimsgroup.com/?l=jetspeed> Problems?: [EMAIL PROTECTED]
