Hi all again,
In this thread we will discuss about the documentation.
We mainly have 2 places for the documentation :
*the /doc in the sources
*the wiki at http://www.shinken-monitoring.org/wiki (not fully translated
for some points)
The /doc is inherited from nagios-fr.org work. It's a Nagios documentation
put in docbook format. This format allow to create xhtml pages (like
shinken-monitoring.org/doc ) and pdf. But docbook is not so easy to work
with. It's like LaTeX, it take some times to be good to work for. It can be
good for a book (that what it is for after all) but we are wondering if it's
the good format for a open source project documentation.
The documentation should be user centric. Dev got problems for writing such
a doc (we talk about parameters, users talk bout use casesfor sending sms
for example). We think the wiki is a better place to put the official
documentation. So everyone can edit it and improve it.
If we are all agree with it, the migration will take time of course and so
will need the help of everyone, but then the users will know where to grab
informations and tutorials.
And if someone want to the the wiki administrator to organize the categories
etc, just say it :)
And the wiki need a cool skin, if someone know dokuwiki, he can propose one
:)
It the same for the website by the way (wordpress based).
Every one is agree with it of someone think we can even improve the
documentation management? (put all in wikipedia website ? ;) )
Jean & Gerhard
------------------------------------------------------------------------------
This SF.net Dev2Dev email is sponsored by:
Show off your parallel programming skills.
Enter the Intel(R) Threading Challenge 2010.
http://p.sf.net/sfu/intel-thread-sfd
_______________________________________________
Shinken-devel mailing list
Shinken-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/shinken-devel
