On Thu, Dec 12, 2013 at 9:21 PM, Thibault Cohen <
thibault.co...@savoirfairelinux.com> wrote:
> One upon a time, a new open source project, named Shinken, had a pretty
> good and up to date documentation.
>
> But, now, technologies have changed and Shinken has evolved but not the
> documentation (unfortunately :) )
>
> The Shinken Nation has to go ahead and change the situation !
>
> ... EPIC SONG ... (http://www.youtube.com/watch?v=Lrdrv_4hz2Y)
>
>
>
> Hello !
>
> So, I started to convert the wiki in rst files and I put it on ReadTheDocs
> - https://github.com/titilambert/shinken-manual
> and the result :
> - http://shinken.readthedocs.org/en/latest/
> This is a preview of what a Shinken manual could be...
>
> ReadThedocs features:
> - Versionning
> - GitHub compatibility
> - Cute
> - Multi output
> So, we have : PDF, HTML, Epub, ManPage (...) and others
>
> So, if we put the documentation in main Shinken git repository we can
> have a documentation AUTOMAGICALLY SYNCHRONIZED with the code for each
> tag of Shinken
>
> Also, about the dev documentation, if we start to use doc string, we can
> have it (again) AUTOMAGICALLY :) (also for each tag)
>
> C
> (\. \ ,/)
> \( |\ )/
> //\ | \ /\\
> (/ /\_#oo#_/\ \)
> \/\ #### /\/
> `##'
>
> (...Automated Gandalf come with us !!!)
>
>
> What do you think about it ?
>
>
>
>
>
> Titilambert
>
> Hi,
I think it's a great idea. The wiki was done for everyone to help on the
huge documentation effort, but thanks to spam and user creation
restriction, it just don't work.
I like the result and the idea. Just one question: is markdown managed
instead of rst? I think it's quite easier to wrote in markdown that rst. If
it manage it maybe we can open a poll and see what the majority prefer :)
We can also migrate the repo to the github organization, so will be
automatically open for all core devs :)
Jean
------------------------------------------------------------------------------
Rapidly troubleshoot problems before they affect your business. Most IT
organizations don't have a clear picture of how application performance
affects their revenue. With AppDynamics, you get 100% visibility into your
Java,.NET, & PHP application. Start your 15-day FREE TRIAL of AppDynamics Pro!
http://pubads.g.doubleclick.net/gampad/clk?id=84349831&iu=/4140/ostg.clktrk
_______________________________________________
Shinken-devel mailing list
Shinken-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/shinken-devel
