ToDo list
This is a todo list full of tasks that need to be done to get the new 2.2 docs published:
1. Minimal
As a first step, we have to provide at least minimal information about Cocoon 2.2 in order to attract more people to use it. Tasks in this section should have precendence over tasks in section 2 or 3 (though it isn't entirely possible to completly separate them.)
|
Description |
Who |
Notes |
Status |
|---|---|---|---|
|
Get the Daisy Maven plugin properly released |
RP |
I've got in contact with Bruno and he gave me green light for cutting an alpha release of it. |
in progress |
|
Create a special 2.2 site |
RP |
Create a Daisy site containing general information about Cocoon 2.2. It will consist of only a handful pages as most of the information should go into the blocks or core modules where it belongs to. |
done |
|
Finish PMC site |
HL |
The PMC site has still some blank pages and sections. |
in progress |
|
Complete pom.xml |
Make sure that cocoon/trunk/pom.xml contains the complete list of current and previous Cocoon committers and PMC members |
open |
|
|
Review PMC site and 2.2 site docs |
Both sites have to be proof-read by a native speaker before they can go online. |
open |
2. Docs for released Cocoon modules
|
Description |
Who |
Notes |
Status |
|---|---|---|---|
|
Verify Daisy backup |
At last year's GT Bertrand worked on the backup. According to him it works but, as request by himself, somebody else should confirm this. |
open |
|
|
Design of content pages |
HL/TL |
The design of the homepage is already done. We also need the design of normal content pages (fixme, warning, note, tables, images, etc.). |
done |
|
Make the design an official contribution |
RP |
The design is created by Thien. As he is not a committer, it would be best if he could add the latest version of his fabulous work to a JIRA task. (I'll ask Thien if it's ok if I do the contribution - HL) |
done |
|
Implement the new design as Maven skin |
HL |
done |
|
|
RSS feed |
RP |
Provide an RSS feed containing the news of the front page and add it to PlanetApache |
open |
|
Configure the Daisy Maven plugins for all module |
RP |
All modules have to be configured correctly in the modules pom.xml. |
done |
|
DocumentType: SitemapComponents |
RP |
Add XSLT for documents of type SitemapComponents |
done |
|
Query type: SitemapComponents |
RP |
Add a special template for SitemapComponents queries |
done |
|
Provide docs for all already released modules |
many |
This task is split up into several sub tasks. See the table below |
open |
This table is a matrix of rather small sub tasks that are required to get the documentation of a particular module (a block, a core module, a Maven plugin) finsihed:
|
Daisy site |
General site |
"documentation" docs |
Wiki docs |
Sitemap components |
changes.xml |
proof-reading |
General notes |
|
|---|---|---|---|---|---|---|---|---|
|
ajax |
done (HL) |
done (RP) |
done (RP) |
|||||
|
auth |
done (HL) |
done (RP) |
done (RP) |
done (RP) |
||||
|
batik |
done (RP) |
done (RP) |
done (RP) |
done (RP) |
||||
|
captcha |
done (HL) |
done (RP) |
done (RP) |
done (RP) |
||||
|
databases |
done (RP) |
done (RP) |
done (RP) |
done (RP) |
||||
|
html |
done (RP) |
done (RP) |
done (RP) |
done (RP) |
||||
|
flowscript |
done (HL) |
done (RP) |
done (RP) |
done (RP) |
||||
|
forms |
done (RP) |
done (RP) |
done (RP) |
|||||
|
fop |
done (HL) |
done (RP) |
done (RP) |
done (RP) |
||||
|
linkrewriter |
done (RP) |
done (RP) |
done (RP) |
done (RP) |
||||
|
|
done (HL) |
done (RP) |
done (RP) |
done (RP) |
||||
|
template |
done (RP) |
done (RP) |
done (RP) |
done (RP) |
explanation of the colum titles:
| Daisy site |
Does the Daisy site, the root navigation document and an index document exist? |
| General site |
Is the new site added to the general site (Cocoon book, administration docs to get easier access to it) |
| Move "documentation" docs |
The Daisy site "documentation" already contains a lot of documents. If there are relevent docs there for a specific module, it has to be moved to it. Don't forget to add it to the new module's collection and remove it from the collection "documentation". |
| Wiki docs |
The wiki contains a lot of high-quality information that is worth of being added to the official docs. |
| Sitemap components |
Sitemap component that contains special qdoc Javadoc attributes, are imported into the Daisy wiki. They are already added to the appropriate collection. The only things that has to be done is adding a query to the module's root navigation document and include it to the query of the "2.2-site" root navigation document which contains a complete list of all sitemap components for the user's convenience. |
| changes.xml |
Does a changes.xml exist and is it up-to-date? Make sure that all releases are listed with the correct release dates. |
| proof reading |
Some native-speaker should proof-read it |
3. The rest
There are even more modules that deserve to be documented:
|
Daisy site |
General site |
"documentation" docs |
Wiki docs |
Sitemap components |
changes.xml |
proof-read |
General notes |
|
|---|---|---|---|---|---|---|---|---|
|
javaflow |
done (HL) |
|||||||
|
lucene |
done (HL) |
|||||||
|
portal |
done (HL) |
|||||||
|
serializers |
done (HL) |
There are no comments.