Preferred format of examples / new examples

[thschue]

As the handling of Makefiles might not always be the preferred way to install examples, we'd like to collect your ideas and thoughts about this at the moment.

To discuss:

• Where should the examples live (at the moment besides the code)?
• Which companion material / installation automation should we provide (currently Makefiles and README)?
• Which examples would you like to see at the moment

We'll keep this discussion open until Nov. 10th.

[mowies]

I would keep them inside the repo under a docs/examples folder maybe.
README with Makefile or README with shell script (if that's easier) sounds reasonable to me. The question is, if we wanna test the example at some point, then we should maybe think about a generalised approach.

[thschue]

I would keep them inside the repo under a docs/examples folder maybe. README with Makefile or README with shell script (if that's easier) sounds reasonable to me. The question is, if we wanna test the example at some point, then we should maybe think about a generalised approach.

I think it would be nice to have the examples tested automatically, therefore we could ensure that they work with each release ... Do you think this might be possible?

[mowies]

Then we would need a standard naming scheme so that it can easily be generalised in pipelines. Also, then next question then would be how to verify that the examples work. What would be the expected outcome that the example should achieve?

[RealAnna]

I guess if we use the example one-to-one for a kuttl based test then we already have a good starting point... no clue for the observability part tho

[grabnerandi]

I like the examples to be next to the code itself - then I have everything in place when I do a git clone.
I also really like the makefiles as they make it easy to run the different example scenarios!

[AloisReitbauer]

I just find the current examples a bit confusing. I am fine having it as part of the code or in a separate repo. The advantage of a having them along the code is that they are always in sync with the release version. However, ideally there is a GitHub repository I can clone which I use for GitOps deployments.

I am for having one example that covers all steps of setting up a production-like example with all components compared to multiple individual examples.