Re: Documentation for Bahir Flink extensions

[Robert Metzger]

I've opened a pull request adding README.md files for the connectors. Once
that is merged I'll copy and adopt the update-doc.sh script.

On Wed, Aug 31, 2016 at 10:32 AM, Robert Metzger 
wrote:

> Okay, I see. I'll soon open my pending pull request [1] for the
> bahir-website repository.
>
>
> [1] https://github.com/apache/bahir-website/pull/7
>
> On Mon, Aug 29, 2016 at 8:43 PM, Luciano Resende 
> wrote:
>
>> There is a strawman of a script that currently does the job and I have
>> been
>> using for the Spark extensions.
>> https://github.com/apache/bahir-website/blob/master/update-doc.sh
>>
>> On Mon, Aug 29, 2016 at 6:54 AM, Robert Metzger 
>> wrote:
>>
>> > +1
>> >
>> > I didn't know that this is possible.
>> >
>> > So how are the contents from the readme file copied to the website?
>> >
>> > On Sat, Aug 27, 2016 at 8:22 AM, Jean-Baptiste Onofré 
>> > wrote:
>> >
>> > > +1
>> > >
>> > > Regards
>> > > JB
>> > >
>> > >
>> > > On 08/26/2016 09:13 PM, Luciano Resende wrote:
>> > >
>> > >> For the Spark extensions we currently have a README.md on each
>> extension
>> > >> project which helps users accessing github to easily find out how to
>> use
>> > >> the extension, and we also use that to "copy" to the website and add
>> > some
>> > >> style to it, so it can also be used as the website documentation.
>> > >>
>> > >> Here is a readme.md
>> > >>
>> > >> https://github.com/apache/bahir/tree/master/sql-streaming-mqtt
>> > >>
>> > >> And then it gets copied to the website as
>> > >>
>> > >> http://bahir.apache.org/docs/spark/current/spark-sql-streaming-mqtt/
>> > >>
>> > >> I would like to propose a similar approach for creating documentation
>> > for
>> > >> the Bahir flink extensions.
>> > >>
>> > >> Thoughts ?
>> > >>
>> > >>
>> > > --
>> > > Jean-Baptiste Onofré
>> > > jbono...@apache.org
>> > > http://blog.nanthrax.net
>> > > Talend - http://www.talend.com
>> > >
>> >
>>
>>
>>
>> --
>> Luciano Resende
>> http://twitter.com/lresende1975
>> http://lresende.blogspot.com/
>>
>
>

Re: Documentation for Bahir Flink extensions

[Robert Metzger]

Okay, I see. I'll soon open my pending pull request [1] for the
bahir-website repository.


[1] https://github.com/apache/bahir-website/pull/7

On Mon, Aug 29, 2016 at 8:43 PM, Luciano Resende 
wrote:

> There is a strawman of a script that currently does the job and I have been
> using for the Spark extensions.
> https://github.com/apache/bahir-website/blob/master/update-doc.sh
>
> On Mon, Aug 29, 2016 at 6:54 AM, Robert Metzger 
> wrote:
>
> > +1
> >
> > I didn't know that this is possible.
> >
> > So how are the contents from the readme file copied to the website?
> >
> > On Sat, Aug 27, 2016 at 8:22 AM, Jean-Baptiste Onofré 
> > wrote:
> >
> > > +1
> > >
> > > Regards
> > > JB
> > >
> > >
> > > On 08/26/2016 09:13 PM, Luciano Resende wrote:
> > >
> > >> For the Spark extensions we currently have a README.md on each
> extension
> > >> project which helps users accessing github to easily find out how to
> use
> > >> the extension, and we also use that to "copy" to the website and add
> > some
> > >> style to it, so it can also be used as the website documentation.
> > >>
> > >> Here is a readme.md
> > >>
> > >> https://github.com/apache/bahir/tree/master/sql-streaming-mqtt
> > >>
> > >> And then it gets copied to the website as
> > >>
> > >> http://bahir.apache.org/docs/spark/current/spark-sql-streaming-mqtt/
> > >>
> > >> I would like to propose a similar approach for creating documentation
> > for
> > >> the Bahir flink extensions.
> > >>
> > >> Thoughts ?
> > >>
> > >>
> > > --
> > > Jean-Baptiste Onofré
> > > jbono...@apache.org
> > > http://blog.nanthrax.net
> > > Talend - http://www.talend.com
> > >
> >
>
>
>
> --
> Luciano Resende
> http://twitter.com/lresende1975
> http://lresende.blogspot.com/
>

Re: Documentation for Bahir Flink extensions

[Luciano Resende]

There is a strawman of a script that currently does the job and I have been
using for the Spark extensions.
https://github.com/apache/bahir-website/blob/master/update-doc.sh

On Mon, Aug 29, 2016 at 6:54 AM, Robert Metzger  wrote:

> +1
>
> I didn't know that this is possible.
>
> So how are the contents from the readme file copied to the website?
>
> On Sat, Aug 27, 2016 at 8:22 AM, Jean-Baptiste Onofré 
> wrote:
>
> > +1
> >
> > Regards
> > JB
> >
> >
> > On 08/26/2016 09:13 PM, Luciano Resende wrote:
> >
> >> For the Spark extensions we currently have a README.md on each extension
> >> project which helps users accessing github to easily find out how to use
> >> the extension, and we also use that to "copy" to the website and add
> some
> >> style to it, so it can also be used as the website documentation.
> >>
> >> Here is a readme.md
> >>
> >> https://github.com/apache/bahir/tree/master/sql-streaming-mqtt
> >>
> >> And then it gets copied to the website as
> >>
> >> http://bahir.apache.org/docs/spark/current/spark-sql-streaming-mqtt/
> >>
> >> I would like to propose a similar approach for creating documentation
> for
> >> the Bahir flink extensions.
> >>
> >> Thoughts ?
> >>
> >>
> > --
> > Jean-Baptiste Onofré
> > jbono...@apache.org
> > http://blog.nanthrax.net
> > Talend - http://www.talend.com
> >
>



-- 
Luciano Resende
http://twitter.com/lresende1975
http://lresende.blogspot.com/

Re: Documentation for Bahir Flink extensions

[Robert Metzger]

+1

I didn't know that this is possible.

So how are the contents from the readme file copied to the website?

On Sat, Aug 27, 2016 at 8:22 AM, Jean-Baptiste Onofré 
wrote:

> +1
>
> Regards
> JB
>
>
> On 08/26/2016 09:13 PM, Luciano Resende wrote:
>
>> For the Spark extensions we currently have a README.md on each extension
>> project which helps users accessing github to easily find out how to use
>> the extension, and we also use that to "copy" to the website and add some
>> style to it, so it can also be used as the website documentation.
>>
>> Here is a readme.md
>>
>> https://github.com/apache/bahir/tree/master/sql-streaming-mqtt
>>
>> And then it gets copied to the website as
>>
>> http://bahir.apache.org/docs/spark/current/spark-sql-streaming-mqtt/
>>
>> I would like to propose a similar approach for creating documentation for
>> the Bahir flink extensions.
>>
>> Thoughts ?
>>
>>
> --
> Jean-Baptiste Onofré
> jbono...@apache.org
> http://blog.nanthrax.net
> Talend - http://www.talend.com
>

Re: Documentation for Bahir Flink extensions

[Jean-Baptiste Onofré]

+1

Regards
JB

On 08/26/2016 09:13 PM, Luciano Resende wrote:

For the Spark extensions we currently have a README.md on each extension
project which helps users accessing github to easily find out how to use
the extension, and we also use that to "copy" to the website and add some
style to it, so it can also be used as the website documentation.

Here is a readme.md

https://github.com/apache/bahir/tree/master/sql-streaming-mqtt

And then it gets copied to the website as

http://bahir.apache.org/docs/spark/current/spark-sql-streaming-mqtt/

I would like to propose a similar approach for creating documentation for
the Bahir flink extensions.

Thoughts ?



--
Jean-Baptiste Onofré
jbono...@apache.org
http://blog.nanthrax.net
Talend - http://www.talend.com

Re: Documentation for Bahir Flink extensions

[Mridul Muralidharan]

+1 sounds good.

Regards
Mridul

On Friday, August 26, 2016, Luciano Resende  wrote:

> For the Spark extensions we currently have a README.md on each extension
> project which helps users accessing github to easily find out how to use
> the extension, and we also use that to "copy" to the website and add some
> style to it, so it can also be used as the website documentation.
>
> Here is a readme.md
>
> https://github.com/apache/bahir/tree/master/sql-streaming-mqtt
>
> And then it gets copied to the website as
>
> http://bahir.apache.org/docs/spark/current/spark-sql-streaming-mqtt/
>
> I would like to propose a similar approach for creating documentation for
> the Bahir flink extensions.
>
> Thoughts ?
>
> --
> Luciano Resende
> http://twitter.com/lresende1975
> http://lresende.blogspot.com/
>