Date: 2005-01-27T05:56:41 Editor: ReinhardPoetz Wiki: Cocoon Wiki Page: 22NewDocuments URL: http://wiki.apache.org/cocoon/22NewDocuments
no comment Change Log: ------------------------------------------------------------------------------ @@ -4,6 +4,8 @@ After a lot of talks in the last months about a new Cocoon documentation it's time to start working on it. I (ReinhardPoetz) propose to create the new documentation from the scratch (--> empty doc base) and decide for every existing document whether it goes into the new documentation or not. +This requires a new infrastructure (see the proposal: CocoonDocumentationSystemSUMMARY) and actual work on the content. + This also means that we need a lot of help to get this going: * all 2.1 '''and''' 2.2 docs have to be reviewed (see the table below) @@ -16,22 +18,19 @@ and ExtremeDocumentationOverhaul == How can you help? == - + + * read CocoonDocumentationSystemHowTo to find some information how the actual work has to be done. * review the existing docs and enter your comments into the table below * write new docs (the source can be plain HTML --> every HTML editor is good enough to write the docs!) and put them into Bugzilla * create patches if the doc already exists in SVN -== Which tools do you need? == - * your web browser (look at the [http://cocoon.apache.org/ top-level] and [http://cocoon.apache.org/2.1/ 2.1] docs) if you want to help to review documents. - * a HTML editor (e.g. Mozilla suite) if you want to create or update documents. - * [http://cocoon.apache.org/community/contrib.html#Subversion+Usage+Precis checkout] the current source documentation from SVN for both trunk (2.2) and cocoon-2_1_X branch. - * Apache Forrest 0.6 (forrest_06_branch) if you want to generate the final documentation locally. - == Reviewing the existing docs == -People reviewing these docs please use the comments field to add your name and summarize your impressions and the reasons for the state you have choosen. + +People reviewing these docs please use the comments field to add your name and summarize your impressions and the reasons for the state you have choosen. Don't forget to have a look at the 2.2 docs in trunk because some of the docs are different to the 2.1 version (see the column in the table below). '''Status:''' * NR ..... not reviewed + * IP ..... in progress (please also add your name to the comments field) * TBR .... to be removed * MV ..... move document to 2.2 without modifications ( * MOD .... move document to 2.2 (requires modifications - described in the comment cell)
