Ideas concerning documentation

Here are collected ideas how the documentation may be improved. Feel free to work on any of the tasks or add new ones – in case you have and want no confluence login, just leave a comment at the bottom of the page. And, by the way, developers as well as total freshmen can contribute to the documentation, as questions/suggestions are as important as the answers.

Concerning the structure and organization

The page Documentation deperately needs to be re-organized and extended with short comments describing the content of the linked page.

Cross-referencing pages where appropriate AND instead of having redundand content (then, only one version might be updated, all other occurences stay outdated/incorrect).

Several tutorials etc. are related to one specific ServiceMix version but do not mention this. Include this info in the title page, duplicate the page and change the duplicate to suit the current version.

Concerning the content

Many examples lack comments in the source code (what does a method/XML-entity do? Why is it needed? Was it created manually or by archetypes?). List todo items here.

Pages that need a clean-up

e.g. formatting, adaption to new ServiceMix version, sequence of content,...

• JConsole / JMX Console / JMX management

Pages that are missing blocks of content

Those tutorials, descriptions etc. exist but are not (any more) complete. If possible, a {note} shall be placed where content is missing, so readers get aware of the missing parts.

• Hello World - SE is started but needs some contribution to be completed
• CIMERO plugin
• nearly all example pages do not help / describe enough for newbies.

Content that is missing completely

• Using out of the box functionality (http component, jsr181 comp, eip comp,...) to create a own SA
• undeployment, see http://mail-archives.apache.org/mod_mbox/geronimo-servicemix-dev/200610.mbox/%3cb23ecedc0610011247v7b435be0ka00ee8e8375230e9@mail.gmail.com%3e