Hi All, Why not aim for the best of both worlds? Imho, samples are similar to docs: each action and transform plugin should come with at least one sample workflow or pipeline that shows its functionality with as few other actions or transforms as possible. We can bundle those into a 'samples' project, and add more complex example workflows and pipelines that show users how to work in more complex situations, implement a number of sample design patterns etc
Regards, Bart On Mon, Jan 25, 2021 at 11:16 AM Hans Van Akelyen < [email protected]> wrote: > Hi Sergio, > > So I think there are a couple things we should consider. The simplest > approach will be to, as you suggested, create a folder in static or some > other location and dump all our samples in there. Another idea that has > come up here and there but should be discussed is to look at the samples in > the same way we are doing our docs, create a sample folder per plugin. This > gives us a clear overview which plugins have samples and in the future we > could add extra checks or warnings to our build process to indicate the > quality of a plugin. For now we are also planning to ship all our > transforms and actions in our distribution release, but at the speed our > set of tools is growing we will have to start choosing at some point in > time and this could mean that samples break. > > Creating samples for each plugin will require a bit more work/thinking as > we need something "smart" to combine all these samples into an actual > sample project that is included in our release. But my personal preference > would be to look at something like this. And apply the same logic to our > integration tests. > > Cheers, > Hans > > On Thu, Jan 21, 2021 at 11:03 PM Sergio Ramazzina (SERASOFT) < > [email protected]> wrote: > > > Ciao Hoppers, > > > > 'm here to start a discussion around how we can create a sample > > distribution because I was preparing samples for my Enchanced JSON > > Output but I discovered that I was unaware about where I can put them in > > our project's codebase structure. Hans told me in our dev chat that > > there isn't any rule or guideline on how to do that and proposed me to > > start a discussion in the dev list to collect ideas on how to do that so > > here I am. > > > > As Matt said in one of our discussions, a good idea could be to generate > > a samples project and put the project's directory our codebase. I agree > > on that. For example under the assembly/static module, in resouce folder > > we could create a new folder named samples and put the project there. > > Then we can include it hop's application archive for distribution. > > > > Any ideas comments on this topic? > > > > Cheers > > > > Sergio > > > > -- > > >
