Problem
In recent PRs #772, #773, #774 we added three new platforms to be supported by Apache Wayang, which is awesome!
However, in doing so, we broke some of the conventions for structuring our code.
We now have multiple ways of providing demo-like examples of how users could run code with specific platforms.
I think this is problematic as it makes it ambiguous for contributors that want to add new code to our project.
Files
The following files were added in non-conventional manner:
Previous convention
Demos or examples were previously found only in wayang-applications or in wayang-benchmark.
Docker in Wayangs source
Additionally, the demo examples added in #772, #773 and #774 provide docker-compose.yml files for each of the platforms to be set up. While I agree that this is convenient for anyone willing to just execute the demo all batteries included, I do not think that these files should be present in the source of Wayang. An example or demo should be configurable to connect to any third party platform via its API, just by a config like we have in many other examples.
This allows us to not rely on too many third party tools and allows users to plug their environment in more seamlessly.
Problem
In recent PRs #772, #773, #774 we added three new platforms to be supported by Apache Wayang, which is awesome!
However, in doing so, we broke some of the conventions for structuring our code.
We now have multiple ways of providing demo-like examples of how users could run code with specific platforms.
I think this is problematic as it makes it ambiguous for contributors that want to add new code to our project.
Files
The following files were added in non-conventional manner:
Previous convention
Demos or examples were previously found only in wayang-applications or in wayang-benchmark.
Docker in Wayangs source
Additionally, the demo examples added in #772, #773 and #774 provide docker-compose.yml files for each of the platforms to be set up. While I agree that this is convenient for anyone willing to just execute the demo all batteries included, I do not think that these files should be present in the source of Wayang. An example or demo should be configurable to connect to any third party platform via its API, just by a config like we have in many other examples.
This allows us to not rely on too many third party tools and allows users to plug their environment in more seamlessly.