Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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 (more correctly: it's children) deperately needs to be re-organized and extended with . Is it possible to extend the child-list short comments describing the content of the linked page.pages?

Cross-referencing pages where appropriate AND instead of having redundand content (then, content. Redundand content is bad, as often only one version might be is updated, but all other occurences of the same information 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

...

  • Hello World - SE is started but needs some contribution to be completed
  • CIMERO Editor plugin
  • nearly Nearly all example pages do not help / describe enough for newbies.
  • 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.

Content that is missing completely