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/
