Re: [DISCUSS] Getting to a 1.0 release

2018-08-18 Thread Nick Allen
I'd like to see us focus on improving our docs before a version 1.0. Right now we just stitch together a bunch of READMEs, which is a great stride from where we started, but is not ideal. Our docs should focused on the user and use cases; What can I do with Metron? Who does it help? How do I do

Re: [DISCUSS] Getting to a 1.0 release

2018-08-18 Thread Nick Allen
Personally, I think the state of our docs and web presence is an inhibitor to growing the Metron community. Unless we can offer concise, compelling answers to the basic questions (What can I do with Metron? Who does it help? How do I do that?), potential users and contributors are unable to see t

Re: [DISCUSS] Getting to a 1.0 release

2018-08-18 Thread Kyle Richardson
+1 to separating developer docs and user docs. How should we approach that. Have a separate doc book? I haven’t had a ton of time to contribute to code lately but I’d be happy to help write some of these. On Sat, Aug 18, 2018 at 9:48 AM Nick Allen wrote: > Personally, I think the state of our do

Re: [DISCUSS] Getting to a 1.0 release

2018-08-18 Thread Nick Allen
Yes, I imagine just a separate top level directory which would contain the docs. We would need someone to survey what doc tools are out there and provide some advice. Maybe we could look around at other open source projects that have done their docs well and emulate them. On Sat, Aug 18, 2018, 1

Re: [DISCUSS] Getting to a 1.0 release

2018-08-18 Thread Michael Miklavcic
Apologies for any spelling mishaps as I'm writing from my phone. I'm for improving our docs. I'd like to see us guide our various profiles of user towards the specific documentation for the abstraction levels they'll be most interested in working from. I think we should have platform docs about ho