+1 for the former. * examples have the same entry will be very convenient for users to looking for. * refer to other projects like spark, it has the `examples` module including `streaming`, `sql`, `ml`.
Also, I'm happy to take part in. Thanks. Xin 2016-06-30 16:39 GMT+08:00 Abhishek Agarwal <[email protected]>: > Hi all, > Right now the example topologies/classes for some external modules are > being put up in the test folder itself. The problem I see is that, > -> the example code isn't really test code so test folder isn't the right > fit. > -> people, who are looking for example code, may not find the example code. > > I can see two solutions - > -> Have module level example directories e.g. examples/storm-opentsdb, > examples/storm-redis > -> Have an examples folder within module itself and example topologies are > put there. > > In any case, it is better to document github links of example code in the > documentation of any external module. > > Let me know what you guys think. > > -- > Regards, > Abhishek Agarwal >
