httpd-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Brian Behlendorf <br...@organic.com>
Subject Re: docs
Date Sun, 01 Dec 1996 19:47:14 GMT
On Sun, 1 Dec 1996, Randy Terbush wrote:
> I'm a bit unclear as to where the intended location is for docs
> that are _not_ module specific. I'm currently assuming htdocs/manual/
> 
> I have also just moved htdocs/manual/howto.html to htdocs/manual/misc/
> since that is where the htdocs/manual/index.html was looking for it.
> There appear to be some other documents that are _not_ referenced
> from any index that I can see in this toplevel doc directory.
> 
> I'm currently in the process of adding docs for SUExec which I have
> placed in htdocs/manual/suexec.html. Could someone let me know if
> I am deviating from "the plan". We should probably all take some time
> to test the docs as well since there has been quite a bit of reorganization
> from what I can see.

When I sat down and laid out an organization a few weeks ago, here was the
thinking behind the separate directories: (look in the archives under the
subject line "docs reorg")

| /manual   - files here are concerned with the day-to-day operation
|             of the server.  Most documentation here is lush, with
|             examples, and is more along the lines of describing the
|             system than documenting specific directives.  Not quite
|             tutorials, but close.
|
| /manual/mod  - documentation on the modules go here.  This documentation
|             is more complete, is exact, and somewhat dry.  It goes
|             directive-by-directive, one file per module.
|
| /manual/misc - here we put files which are of interest to developers and
|             hardcore users, where we document interfaces (API.html,
|             client_block_api.html), give performance and security tips
|             maybe a little history (nopgp.html), document bugs and FAQ's,
|             etc.

So I'd say placing the suexec stuff under /manual is just fine.

	Brian

--=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=--
brian@organic.com  www.apache.org  hyperreal.com  http://www.organic.com/JOBS


Mime
View raw message