Meecrowave Samples Documentation

[Mark Struberg <st...@yahoo.de.INVALID>]

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

Re: Meecrowave Samples Documentation

[Romain Manni-Bucau <rm...@gmail.com>]

works for me

do we want to generate some example site from that and include it in the
doc website like http://tomee.apache.org/examples/index.html ?
Asciidoc will give us tags instead of faking the categories which can be
nice. We can for sure start from
https://github.com/apache/tomee-site-generator/blob/master/src/main/java/org/apache/tomee/website/Examples.java
to hack something if desired.

Romain Manni-Bucau
@rmannibucau <https://twitter.com/rmannibucau> |  Blog
<https://rmannibucau.metawerx.net/> | Old Blog
<http://rmannibucau.wordpress.com> | Github <https://github.com/rmannibucau> |
LinkedIn <https://www.linkedin.com/in/rmannibucau> | Book
<https://www.packtpub.com/application-development/java-ee-8-high-performance>


Le mer. 18 juil. 2018 à 08:50, Mark Struberg <st...@yahoo.de.invalid> a
écrit :

> 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
>
>