devonfw / cobigen

Code-based Incremental Generator
Apache License 2.0
36 stars 72 forks source link

Add tutorial slides for Ionic CRUD generation #569

Open jdiazgon opened 6 years ago

jdiazgon commented 6 years ago

It would be nice to add a tutorial before the log-in, similar to what is shown below:

image

It is explained here how to do it.

However my question for @maybeec is this: Should the tutorial be added to the sample application as default, or should we implement some templates and generate this tutorial with CobiGen?

I would go for the first option actually. Though, is the sample application going to be used for something different rather than for the Ionic Crud? If it is going to be used for different things, maybe the tutorial wouldn't be effective in the sample application.

maybeec commented 6 years ago

Can you check how easy it is to add a tutorial to an existing application based on the application template by our merging strategies? If it is possible, we should have both. On the one hand we can easily put it into the sample app. Totally fine for me, but if it is easy to be generated and maybe even automatically integrated into an existing application, we should even provide a new increment for this in CobiGen. @sjimenez77 do you have also an oppinion about that?

sjimenez77 commented 6 years ago

From my point of view, the tutorial intro is a great idea that could be included in the sample application. The problem would be that not all the applications need a tutorial intro. For that reason I think that if we want to include it, it should be added as an option in Cobigen, I mean, another check in the wizard, that would add the necessary files to any Ionic project built by Cobigen.

Besides this, another option could be to add this and future features as branches in our sample app. In this way we would be able to have both. But then, the question that comes to my mind would be, do we want to maintain combinations of our sample app in different branches to match the most common needs or it is enough and easier to have those features as selectable Cobigen templates only?

My bet is the second option.

jdiazgon commented 6 years ago

or it is enough and easier to have those features as selectable Cobigen templates only

I agree. I will test whether adding the tutorials is easy by our merging strategies or not. I think that option is the one that makes more sense.

maybeec commented 6 years ago

I would also go with option 2. However, the PO of the ionic sample app should now this to even maintain templates or just try them out from time to time. For a later stage it might be worth to try to create integration tests for the templates, i.e. cloning the ionic sample, generating the templates, running the app and have an E2E test using selenium or something like this. This would be the best solution to assure compatibility in future. The test should run with the templates as well with the ionic application template as well.

github-actions[bot] commented 5 years ago

Stale topic. Please negotiate closing or discussing the relevance of this ticket.