You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@storm.apache.org by Abhishek Agarwal <ab...@gmail.com> on 2016/06/30 08:39:25 UTC

[DISCUSS] Maintaining example topologies for external components

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

Re: [DISCUSS] Maintaining example topologies for external components

Posted by Xin Wang <da...@gmail.com>.
Thanks, here is the PR https://github.com/apache/storm/pull/1565.

2016-07-14 12:44 GMT+08:00 Abhishek Agarwal <ab...@gmail.com>:

> Not at all Xin. Please go ahead.
> On Jul 14, 2016 7:46 AM, "Xin Wang" <da...@gmail.com> wrote:
>
> > hi Abhishek,
> > I have done a lot for this. Do you mind I file a Jira and make a pull
> > request for this?
> >
> >
> > 2016-07-07 17:47 GMT+08:00 Abhishek Agarwal <ab...@gmail.com>:
> >
> > > Alright. The majority seems to be in agreement over submodules inside
> > > examples. I will do the clean up of existing modules. Post that, we can
> > > follow the same rule for new modules.
> > >
> > > On Thu, Jun 30, 2016 at 8:32 PM, Cody Innowhere <e....@gmail.com>
> > > wrote:
> > >
> > > > We can have examples in perspective modules and gather the example
> > > > binaries(jars) together into one directory (each in a sub directory)
> by
> > > > adding a maven task.
> > > >
> > > > On Thu, Jun 30, 2016 at 10:12 PM, Jungtaek Lim <ka...@gmail.com>
> > > wrote:
> > > >
> > > > > Thanks Abhishek for bring good topic to discuss.
> > > > > Personally I'm either fine. The thing I'd just like to see is
> having
> > a
> > > > > general rule across all external modules.
> > > > >
> > > > > Thanks,
> > > > > Jungtaek Lim (HeartSaVioR)
> > > > >
> > > > >
> > > > > 2016년 6월 30일 (목) 오후 11:09, Satish Duggana <
> sduggana@hortonworks.com
> > >님이
> > > > 작성:
> > > > >
> > > > > > Hi Xin,
> > > > > > I am fine with having multiple submodules in samples/examples
> > module.
> > > > > >
> > > > > > Thanks,
> > > > > > Satish.
> > > > > >
> > > > > > On 6/30/16, 6:51 PM, "Xin Wang" <da...@gmail.com> wrote:
> > > > > >
> > > > > > hi Satish,
> > > > > > In one `examples` directory not mean they must be in the same
> java
> > > > maven
> > > > > > project. we can create several projects. e.g.
> > > examples/storm-opentsdb,
> > > > > > examples/storm-redis.
> > > > > >
> > > > > > 2016-06-30 21:04 GMT+08:00 Xin Wang <da...@gmail.com>:
> > > > > >
> > > > > > > +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 <
> > abhishcool@gmail.com
> > > >:
> > > > > > >
> > > > > > >> 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
> > > > > > >>
> > > > > > >
> > > > > > >
> > > > > >
> > > > > >
> > > > > >
> > > > >
> > > >
> > >
> > >
> > >
> > > --
> > > Regards,
> > > Abhishek Agarwal
> > >
> >
>

Re: [DISCUSS] Maintaining example topologies for external components

Posted by Abhishek Agarwal <ab...@gmail.com>.
Not at all Xin. Please go ahead.
On Jul 14, 2016 7:46 AM, "Xin Wang" <da...@gmail.com> wrote:

> hi Abhishek,
> I have done a lot for this. Do you mind I file a Jira and make a pull
> request for this?
>
>
> 2016-07-07 17:47 GMT+08:00 Abhishek Agarwal <ab...@gmail.com>:
>
> > Alright. The majority seems to be in agreement over submodules inside
> > examples. I will do the clean up of existing modules. Post that, we can
> > follow the same rule for new modules.
> >
> > On Thu, Jun 30, 2016 at 8:32 PM, Cody Innowhere <e....@gmail.com>
> > wrote:
> >
> > > We can have examples in perspective modules and gather the example
> > > binaries(jars) together into one directory (each in a sub directory) by
> > > adding a maven task.
> > >
> > > On Thu, Jun 30, 2016 at 10:12 PM, Jungtaek Lim <ka...@gmail.com>
> > wrote:
> > >
> > > > Thanks Abhishek for bring good topic to discuss.
> > > > Personally I'm either fine. The thing I'd just like to see is having
> a
> > > > general rule across all external modules.
> > > >
> > > > Thanks,
> > > > Jungtaek Lim (HeartSaVioR)
> > > >
> > > >
> > > > 2016년 6월 30일 (목) 오후 11:09, Satish Duggana <sduggana@hortonworks.com
> >님이
> > > 작성:
> > > >
> > > > > Hi Xin,
> > > > > I am fine with having multiple submodules in samples/examples
> module.
> > > > >
> > > > > Thanks,
> > > > > Satish.
> > > > >
> > > > > On 6/30/16, 6:51 PM, "Xin Wang" <da...@gmail.com> wrote:
> > > > >
> > > > > hi Satish,
> > > > > In one `examples` directory not mean they must be in the same java
> > > maven
> > > > > project. we can create several projects. e.g.
> > examples/storm-opentsdb,
> > > > > examples/storm-redis.
> > > > >
> > > > > 2016-06-30 21:04 GMT+08:00 Xin Wang <da...@gmail.com>:
> > > > >
> > > > > > +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 <
> abhishcool@gmail.com
> > >:
> > > > > >
> > > > > >> 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
> > > > > >>
> > > > > >
> > > > > >
> > > > >
> > > > >
> > > > >
> > > >
> > >
> >
> >
> >
> > --
> > Regards,
> > Abhishek Agarwal
> >
>

Re: [DISCUSS] Maintaining example topologies for external components

Posted by Xin Wang <da...@gmail.com>.
hi Abhishek,
I have done a lot for this. Do you mind I file a Jira and make a pull
request for this?


2016-07-07 17:47 GMT+08:00 Abhishek Agarwal <ab...@gmail.com>:

> Alright. The majority seems to be in agreement over submodules inside
> examples. I will do the clean up of existing modules. Post that, we can
> follow the same rule for new modules.
>
> On Thu, Jun 30, 2016 at 8:32 PM, Cody Innowhere <e....@gmail.com>
> wrote:
>
> > We can have examples in perspective modules and gather the example
> > binaries(jars) together into one directory (each in a sub directory) by
> > adding a maven task.
> >
> > On Thu, Jun 30, 2016 at 10:12 PM, Jungtaek Lim <ka...@gmail.com>
> wrote:
> >
> > > Thanks Abhishek for bring good topic to discuss.
> > > Personally I'm either fine. The thing I'd just like to see is having a
> > > general rule across all external modules.
> > >
> > > Thanks,
> > > Jungtaek Lim (HeartSaVioR)
> > >
> > >
> > > 2016년 6월 30일 (목) 오후 11:09, Satish Duggana <sd...@hortonworks.com>님이
> > 작성:
> > >
> > > > Hi Xin,
> > > > I am fine with having multiple submodules in samples/examples module.
> > > >
> > > > Thanks,
> > > > Satish.
> > > >
> > > > On 6/30/16, 6:51 PM, "Xin Wang" <da...@gmail.com> wrote:
> > > >
> > > > hi Satish,
> > > > In one `examples` directory not mean they must be in the same java
> > maven
> > > > project. we can create several projects. e.g.
> examples/storm-opentsdb,
> > > > examples/storm-redis.
> > > >
> > > > 2016-06-30 21:04 GMT+08:00 Xin Wang <da...@gmail.com>:
> > > >
> > > > > +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 <abhishcool@gmail.com
> >:
> > > > >
> > > > >> 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
> > > > >>
> > > > >
> > > > >
> > > >
> > > >
> > > >
> > >
> >
>
>
>
> --
> Regards,
> Abhishek Agarwal
>

Re: [DISCUSS] Maintaining example topologies for external components

Posted by Abhishek Agarwal <ab...@gmail.com>.
Alright. The majority seems to be in agreement over submodules inside
examples. I will do the clean up of existing modules. Post that, we can
follow the same rule for new modules.

On Thu, Jun 30, 2016 at 8:32 PM, Cody Innowhere <e....@gmail.com> wrote:

> We can have examples in perspective modules and gather the example
> binaries(jars) together into one directory (each in a sub directory) by
> adding a maven task.
>
> On Thu, Jun 30, 2016 at 10:12 PM, Jungtaek Lim <ka...@gmail.com> wrote:
>
> > Thanks Abhishek for bring good topic to discuss.
> > Personally I'm either fine. The thing I'd just like to see is having a
> > general rule across all external modules.
> >
> > Thanks,
> > Jungtaek Lim (HeartSaVioR)
> >
> >
> > 2016년 6월 30일 (목) 오후 11:09, Satish Duggana <sd...@hortonworks.com>님이
> 작성:
> >
> > > Hi Xin,
> > > I am fine with having multiple submodules in samples/examples module.
> > >
> > > Thanks,
> > > Satish.
> > >
> > > On 6/30/16, 6:51 PM, "Xin Wang" <da...@gmail.com> wrote:
> > >
> > > hi Satish,
> > > In one `examples` directory not mean they must be in the same java
> maven
> > > project. we can create several projects. e.g. examples/storm-opentsdb,
> > > examples/storm-redis.
> > >
> > > 2016-06-30 21:04 GMT+08:00 Xin Wang <da...@gmail.com>:
> > >
> > > > +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 <ab...@gmail.com>:
> > > >
> > > >> 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
> > > >>
> > > >
> > > >
> > >
> > >
> > >
> >
>



-- 
Regards,
Abhishek Agarwal

Re: [DISCUSS] Maintaining example topologies for external components

Posted by Cody Innowhere <e....@gmail.com>.
We can have examples in perspective modules and gather the example
binaries(jars) together into one directory (each in a sub directory) by
adding a maven task.

On Thu, Jun 30, 2016 at 10:12 PM, Jungtaek Lim <ka...@gmail.com> wrote:

> Thanks Abhishek for bring good topic to discuss.
> Personally I'm either fine. The thing I'd just like to see is having a
> general rule across all external modules.
>
> Thanks,
> Jungtaek Lim (HeartSaVioR)
>
>
> 2016년 6월 30일 (목) 오후 11:09, Satish Duggana <sd...@hortonworks.com>님이 작성:
>
> > Hi Xin,
> > I am fine with having multiple submodules in samples/examples module.
> >
> > Thanks,
> > Satish.
> >
> > On 6/30/16, 6:51 PM, "Xin Wang" <da...@gmail.com> wrote:
> >
> > hi Satish,
> > In one `examples` directory not mean they must be in the same java maven
> > project. we can create several projects. e.g. examples/storm-opentsdb,
> > examples/storm-redis.
> >
> > 2016-06-30 21:04 GMT+08:00 Xin Wang <da...@gmail.com>:
> >
> > > +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 <ab...@gmail.com>:
> > >
> > >> 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
> > >>
> > >
> > >
> >
> >
> >
>

Re: [DISCUSS] Maintaining example topologies for external components

Posted by Jungtaek Lim <ka...@gmail.com>.
Thanks Abhishek for bring good topic to discuss.
Personally I'm either fine. The thing I'd just like to see is having a
general rule across all external modules.

Thanks,
Jungtaek Lim (HeartSaVioR)


2016년 6월 30일 (목) 오후 11:09, Satish Duggana <sd...@hortonworks.com>님이 작성:

> Hi Xin,
> I am fine with having multiple submodules in samples/examples module.
>
> Thanks,
> Satish.
>
> On 6/30/16, 6:51 PM, "Xin Wang" <da...@gmail.com> wrote:
>
> hi Satish,
> In one `examples` directory not mean they must be in the same java maven
> project. we can create several projects. e.g. examples/storm-opentsdb,
> examples/storm-redis.
>
> 2016-06-30 21:04 GMT+08:00 Xin Wang <da...@gmail.com>:
>
> > +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 <ab...@gmail.com>:
> >
> >> 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
> >>
> >
> >
>
>
>

Re: [DISCUSS] Maintaining example topologies for external components

Posted by Satish Duggana <sd...@hortonworks.com>.
Hi Xin,
I am fine with having multiple submodules in samples/examples module.

Thanks,
Satish.

On 6/30/16, 6:51 PM, "Xin Wang" <da...@gmail.com> wrote:

hi Satish,
In one `examples` directory not mean they must be in the same java maven
project. we can create several projects. e.g. examples/storm-opentsdb,
examples/storm-redis.

2016-06-30 21:04 GMT+08:00 Xin Wang <da...@gmail.com>:

> +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 <ab...@gmail.com>:
>
>> 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
>>
>
>



Re: [DISCUSS] Maintaining example topologies for external components

Posted by Xin Wang <da...@gmail.com>.
hi Satish,
In one `examples` directory not mean they must be in the same java maven
project. we can create several projects. e.g. examples/storm-opentsdb,
examples/storm-redis.

2016-06-30 21:04 GMT+08:00 Xin Wang <da...@gmail.com>:

> +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 <ab...@gmail.com>:
>
>> 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
>>
>
>

Re: [DISCUSS] Maintaining example topologies for external components

Posted by Xin Wang <da...@gmail.com>.
+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 <ab...@gmail.com>:

> 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
>

Re: [DISCUSS] Maintaining example topologies for external components

Posted by Satish Duggana <sa...@gmail.com>.
It is better to have examples/samples in respective modules than in a
single examples/samples module. Sometimes multiple modules can have
conflicting dependencies and having one sample module makes that very
difficult.

Thanks,
Satish.

On Thu, Jun 30, 2016 at 2:09 PM, Abhishek Agarwal <ab...@gmail.com>
wrote:

> 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
>