[OpenSER-Docs] module docs - FAQ

Daniel-Constantin Mierla miconda at gmail.com
Fri Feb 29 14:51:54 CET 2008


On 02/29/08 14:32, Iñaki Baz Castillo wrote:
> El Friday 29 February 2008 13:21:18 Henning Westerholt escribió:
>> Hi all,
>> at the moment the modules documentation ships with this FAQ blocks that
>> gives a few links to the openser homepage and the bugtracker, e.g.:
>> http://www.openser.org/docs/modules/1.3.x/lcr.html#AEN424
>> Its necessary to include this kind of information at this place? The
>> persons that reads the documentation probably already found the openser
>> homepage.. ;-)
>> Or perhaps this FAQ block should be extended? What do you think?
> That block is IMHO completely useless. In fact, just a few modules include 
> real **module FAQ** info in that section, but sometimes this info is lost for 
> the reader since it's used to see nothing useful in that FAQ section.
> For example, take a look to "nathelper" module FAQ section:
>   http://www.openser.org/docs/modules/1.3.x/nathelper.html#AEN424
> Note the point "3.1 What happend with "rtpproxy_disable" parameter?".
> this is the only real useful point of all the FAQ. Why not jsut leave it and 
> remove all the rest?
I guess such general FAQ can be separated, referenced in the file that 
will be the entry point for openser documentation. For each module will 
stay only specific part, if that exists.



More information about the sr-docs mailing list