On Wed, 2012-02-29 at 17:10 -0500, Nicolas LE BAS wrote: > > A - committed for request-api, some more to do > B - in progress > D - in progress, undergoing review > E - needs more detail and a minimalistic approach > F - in progress, awaiting paperwork
We have the paperwork. We just need an improved patch from morten, this time attached to the jira issue. I believe it is in progress. > So I've been trying to look at our needs for documentation, and here are > my findings so far: > - I'm having a hard time running "mvn clean site:stage" and have all the > reports available. Some checkstyle and emma reports are missing, and jxr > reports are generated but not staged. Perhaps I'm not doing it right... > but I guess this would be our first task. You need to use maven-3 for site. > - tiles-eval is not used anywhere in tiles, yet. Should we finish > migrating Tiles to that API (doesn't seem difficult), or should we > exclude it from the scope of tiles-3? This was to Antonio's wishes. I do not know the scope so can't answer when it should be aimed to be included. But i would like to help to get it done, now or later. > - One aspect of the documentation is the javadoc. I think we should at > least satisfy the checkstyle warnings about missing javadoc (except for > missing package-info.java in src/test). Some of it is grossly obsolete, > too, like org.apache.tiles.package-info.java still refering to struts-tiles. Yes. No documentation is better than wrong documentation. > - Another aspect is the web site, with 2 kinds of documentation: dev and > user. Dev doc needs to account for the new spin-off projects autotag and > request, as well as minor updates (Java 6.0...). User doc should need > some writing for new "request" and "autotag" projects, and only a simple > review for the main "framework" project. Can this be done post 3.0 release? Or is too much of it part of the maven built site which becomes fixed once 3.0 is released? > - updating tiles-showcase: have we even had a look at it? no :-/ Does it also need to be *in* the 3.0 release, or can it be done afterwards? ~mck -- "We are what we think. All that we are arises with our thoughts. With our thoughts, we make the world." Buddha | http://github.com/finn-no | http://tech.finn.no |
signature.asc
Description: This is a digitally signed message part
