Re: review of sitemap component documentation
David Crossley wrote: Okay the initial coordination table is now ready. http://cocoon.apache.org/2.1/plan/review-sitemap-docs.html The next task is to review the table to ensure that all entries have been added for sitemap components. Are you proposing to update all of the docs in 2.1.X and then later synchronise with trunk? I have just written up the RequestMethodSelector after an 'oh, aren't the docs crap' complaint on user list, and am not sure whether to put it in trunk as well or not. Regards, Upayavira
Re: review of sitemap component documentation
Upayavira wrote: David Crossley wrote: Okay the initial coordination table is now ready. http://cocoon.apache.org/2.1/plan/review-sitemap-docs.html The next task is to review the table to ensure that all entries have been added for sitemap components. Are you proposing to update all of the docs in 2.1.X and then later synchronise with trunk? I have just written up the RequestMethodSelector after an 'oh, aren't the docs crap' complaint on user list, and am not sure whether to put it in trunk as well or not. I have been wondering how to handle that. In the past we have kept the trunk and the release branch synchronised. It is too easy to lose stuff otherwise. Sometimes the docs are deliberately different, so it will be impossible to do a 'diff -r' to keep a check on things. So i think that it is better to keep synchonised as we go. What do you reckon? --David
Re: review of sitemap component documentation
Le 2 déc. 04, à 04:32, David Crossley a écrit : Okay the initial coordination table is now ready. http://cocoon.apache.org/2.1/plan/review-sitemap-docs.html big big thanks for making this happen, it is an important step I think. Hope to find time to help here. Maybe a periodic nag email to here with the number of unreviewed entries would be good? And/or a single bugzilla issue to keep track of the work done on this table might be good? Did you document the process already, i.e. how do new entries come into the table when someone adds a new component? (I have not reread the whole thread so I might be missing something obvious, please bear with me). -Bertrand smime.p7s Description: S/MIME cryptographic signature
Re: review of sitemap component documentation
Bertrand Delacretaz wrote: David Crossley a écrit : Okay the initial coordination table is now ready. http://cocoon.apache.org/2.1/plan/review-sitemap-docs.html big big thanks for making this happen, it is an important step I think. Hope to find time to help here. You already are. Maybe a periodic nag email to here with the number of unreviewed entries would be good? The xdocs source for that doc is consistent and has some xml comments. It could be parsed and grepped with standard UNIX tools or could be processed with an ant task and XSL. I do want to use tools to help process the xml table. For example, i have a 'sed' script to add a blank column. Should i commit those somewhere? And/or a single bugzilla issue to keep track of the work done on this table might be good? Not sure what you mean there. I was expecting that just the svn commit log messages would suffice. However, i was wondering about using Bugzilla to assist somehow. Perhaps have one bugzilla entry per document, then have a parent issue that creates a roadmap from the child issues. Each issue would enable people to add patches or even comments about that particular sitemap component. Did you document the process already, i.e. how do new entries come into the table when someone adds a new component? (I have not reread the whole thread so I might be missing something obvious, please bear with me). Good questions. I do have a local work log of the steps, so that i can repeat it later. My inial goal was to set up a functional table manually, then work on ways to automate its population and ways to ensure that it stays synchronised. I developed some basic UNIX shell scripts to scan the code and xdocs. The output was manually reviewed to weed out some cruft. After an initial automated load, rows were added manually with copy-and-paste. The next steps are in the To Do list at the bottom of that coordination page. Let us take it steadily. It is a long road. --David
Re: review of sitemap component documentation
David Crossley wrote:
Okay the initial coordination table is now ready.
http://cocoon.apache.org/2.1/plan/review-sitemap-docs.html
Wow, impressive work!
The next task is to review the table to ensure that
all entries have been added for sitemap components.
Another impressive work to do ;-)
Sylvain
--
Sylvain Wallez Anyware Technologies
http://www.apache.org/~sylvain http://www.anyware-tech.com
{ XML, Java, Cocoon, OpenSource }*{ Training, Consulting, Projects }
RE: review of sitemap component documentation
Great! Thanks for doing this. Bye, Helma -Original Message- From: David Crossley [mailto:[EMAIL PROTECTED] Sent: Thursday, 02 December, 2004 04:32 To: [EMAIL PROTECTED] Subject: review of sitemap component documentation Okay the initial coordination table is now ready. http://cocoon.apache.org/2.1/plan/review-sitemap-docs.html The next task is to review the table to ensure that all entries have been added for sitemap components. --David
Re: review of sitemap component documentation
superb effort David thanks! Cheers Jorg David Crossley wrote: Okay the initial coordination table is now ready. http://cocoon.apache.org/2.1/plan/review-sitemap-docs.html The next task is to review the table to ensure that all entries have been added for sitemap components. --David
Re: review of sitemap component documentation
David Crossley wrote: Okay the initial coordination table is now ready. http://cocoon.apache.org/2.1/plan/review-sitemap-docs.html The next task is to review the table to ensure that all entries have been added for sitemap components. At a glance I can see that Ant generator from scratchpad is missing (org.apache.cocoon.ant.AntBuildGenerator). Regards, P.S. Thanks a lot, this is something that goes a long way towards narrowing the code/doc divide in Cocoon. --- Luca Morandini [EMAIL PROTECTED] http://www.lucamorandini.it ---
Re: review of sitemap component documentation
David Crossley wrote: Okay the initial coordination table is now ready. http://cocoon.apache.org/2.1/plan/review-sitemap-docs.html The next task is to review the table to ensure that all entries have been added for sitemap components. applause/ -- Stefano.
Re: review of sitemap component documentation
Luca Morandini wrote: At a glance I can see that Ant generator from scratchpad is missing (org.apache.cocoon.ant.AntBuildGenerator). Thanks Luca, that revealed a flaw in my 'find' script. I was expecting stuff to be organised in directories like org/apache/cocoon/.../generation/ etc. However, there are others like: org/apache/cocoon/ant/AntBuildGenerator.java So now i am finding based on filenames, e.g. *Generator.java Updated table coming soon. --David
