Nick, What is the advantage of Mkdocs over the Wiki or Github readme?
Thanks, James 05.07.2016, 08:30, "Nick Allen" <[email protected]>: > FWIW, I think it would be great to use Mkdocs [1] to create centralized > documentation that we keep managed under source control. We can then use > Mkdocs to publish a version of the documentation for each release. > > [1] http://www.mkdocs.org/ > > On Sun, Jul 3, 2016 at 10:38 PM, Waterson, Kevin < > [email protected]> wrote: > >> Awesome, >> >> I will begin with installation, following the existing docs at >> https://cwiki.apache.org/confluence/display/METRON/Documentation >> >> Anything which is missing I will be able to flesh out, and other docs can >> be created as I become more familiar with the application. >> >> Kind regards >> Kevin >> >> -----Original Message----- >> From: Nick Allen [mailto:[email protected]] >> Sent: Thursday, 30 June 2016 10:16 AM >> To: [email protected] >> Subject: Re: Introduction >> >> Looking to help with documentation? How lucky are we! We need a lot of >> help in this area. >> >> We have some level of documentation dispersed in READMEs embedded in the >> code base and more in the Metron Wiki. Bringing it all together somehow >> would be a vast improvement. >> >> Welcome Kevin >> On Jun 29, 2016 4:49 PM, "Waterson, Kevin" < >> [email protected]> >> wrote: >> >> > Hi all, >> > New to metron and hope to get involved in documentation at some time. >> > >> > Currently working with larger telco in southeast asia region. >> > >> > Looking forward to contributing. >> > >> > Kind regards >> > Kevin >> > > > -- > Nick Allen <[email protected]> ------------------- Thank you, James Sirota PPMC- Apache Metron (Incubating) jsirota AT apache DOT org
