Re: Documentation for Bahir Flink extensions
+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
+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/ >
Re: Documentation for Bahir Flink extensions
+1 Sounds reasonable. On Fri, Aug 26, 2016 at 12: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 ? > > -- > Luciano Resende > http://twitter.com/lresende1975 > http://lresende.blogspot.com/ >
Documentation for Bahir Flink extensions
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/
