Hi Hoppers,

It took a bit to figure this out but PR 588 now includes an automatic way
of picking up all 'src/main/samples' folders in the various plugins in our
wonderful project.  Thanks for the feedback so far.

The 'samples' project is the companion of the 'default' project and is
pretty much coming along as discussed earlier.

I wrote some docs
<https://github.com/apache/incubator-hop-docs/blob/cb83f1db498f26c6f93bd51dc25fc64948241a8f/hop-dev-manual/modules/ROOT/pages/plugin-samples.adoc>
on how to include samples. (Please merge along with PR588)

What is needed are suggestions as to how the folder structure should look
like when all is said and done.  I'm strongly in favor of keeping things
simple with the naming standard:

Folders:
* transforms/ : transform examples
* actions/ : action examples
* beam/ : beam examples

File naming:
<name of the transform/action> - <what it is demoed>.<hpl/hwf>

If we could reach some sort of consensus I can add this to the
documentation.
Perhaps as a minimum we could have a note in the pipeline or workflow
describing what the sample in question does?  Other ideas?

Cheers,
Matt

Reply via email to