Hi folks!

Yesterday night I started improving the documentation of our examples in 
https://github.com/apache/openwebbeans-meecrowave-examples

I moved up all the plugin and dependency definitions so that each example is 
almost self-contained.
The only exception is the various version properties, e.g. meecrowave.version 
and Java language settings. 
This is still in the root pom.

One step for better documentation is to provide a separate README.adoc for each 
example.
The readme should contain a short description what the goal of the example is 
plus an overal explanation of the context and relationship of the parts 
involved.

This should also contain links to the source files which contain the most 
important parts. 
To create a relative link in asciidoc you have to write

link:src/main/java/some/package/Myclass.java[Some Description]

An example can be found here:
https://github.com/apache/openwebbeans-meecrowave-examples/blame/master/rest-trivial/README.adoc#L7

Wdyt of this approach? 


LieGrue,
strub

Reply via email to