httpd-docs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Joshua Slive <sl...@finance.commerce.ubc.ca>
Subject env.html and a template for future docs
Date Tue, 10 Oct 2000 18:04:14 GMT
So, here is a second draft of my "Apache Environment Variables"
doc.  It is also an example of the format I would image future
task-specific docs could take.  The idea is quite simple:

1. Take a task/topic.

2. List all related modules.

3. List all related directives.

4. Provide a brief discussion of how the directives work,
and how they are related to each other.  Extensive detail is not
necessary, because it should be covered in the directive definitions.

5. Provide a few examples.

I imagine the same general format could work for a whole new set
of documentation addressing things like authentication, 
logging, process creation, etc.  This is not meant to replace the
tutorials and books that are being written about Apache.  Rather,
it is just a way to give people a fighting chance to understand the server
as a whole from the docs.

As always, comments and suggestions are welcome.

-- 
Joshua Slive
slive@finance.commerce.ubc.ca
http://finance.commerce.ubc.ca/~slive/
Phone: (604) 822-1871

Mime
View raw message