[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]

Re: Documentating the configuration files



At 09:05 27/12/2003, Karsten Wade wrote:
On Fri, 2003-12-26 at 15:18, Jan Fabry wrote:
> Hello,
>
> Are there any plans to documentate the configuration files,



This is an interesting idea. It is reminiscent of the RHEL Reference
Guide
(http://www.redhat.com/docs/manuals/enterprise/RHEL-3-Manual/ref-guide/), which has many chapters devoted to config files. Of course, something of that size and type _is_ out of scope for the Fedora docs project.


However, a very tight config file reference that was e.g. organized sets
of files done as multiple <variablelist> entries would be very useful,
even if such a reference work is outside of the FDP scope.

The real question is, how do you decide what exactly to document?


<snip/>

I like the idea.
A simpler start might be:

1. List the files, a two line description of what they are for,
   possibly any cross links (see also xxx) (impacts on yyy)
2. From that, it would be possible to develop into a further detailed
   document. The comment about it needing lots of updates would be
   a good 'stop here' notice.
*if* the man pages are adequate, then a reference to them might
be the final entry? If not it at least points out the need for a man page?

HTH daveP





[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]