STATUS revision ccb0e7c8344d788f6f9cd4eea02203429636ae86
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan HuntApache HTTP Server 2.0 Documentation Status File.
86f221492f6f6b71c1114e3edba7373aa93d906bMark AndrewsLast modified: $Date: 2002/09/05 10:21:51 $
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan HuntIf you are interested in helping accomplish some of the tasks on this
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Huntlist or otherwise improving the documentation, please join the
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Huntapache-docs mailing list by mailing to apache-docs-subscribe@apache.org
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan HuntFor more information on how to contribute to the Apache Documentation
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan HuntProject, please see http://httpd.apache.org/docs-project/, and
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunthttp://apache-server.com/tutorials/ATdocs-project.html for an excellent
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunttutorial on how to get started with making your contribution.
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt ------------------------------
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt - The xsl transformations could be greatly improved to a) look better
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt and b) use proper CSS+html rather than the horrible hack that
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt Joshua did (in progress).
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt - Rewriting of the remainder of the manual into xml is in
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt- modules docs
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt - mod_suexec: very little documentation
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt - mod_proxy: updates for 2.0
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt - mod_status: updates for 2.0
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt - mod_example: updates for 2.0
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt - Some of the man pages need to be updated for 2.0. At least
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt the httpd man page appears to be outdated, and perhaps other.
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt After this is done, the manual/programs/ versions can be
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt regenerated using the program in the site-tools repository.
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt- MPM documentation
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt - Each MPM needs to have a documentation file in manual/mod/
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt which lists the directives it provides, and some details
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt about its operation.
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt Status: Initial outlines done. Much more details need to be
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt - Non unix/windows MPMs still need to be completed.
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt - the perchild directives in threaded/worker need docs
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt - Individual docs will need some cleanup.
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt Status: What docs still need to be touched here?
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt - misc/custom_errordocs.html needs to be updated to
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt essentially describe how the international error
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt docs included in 2.0 work
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt - misc/perf-tuning.html - needs major rewrite for 2.0
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt - misc/tutorials.html - mostly not relevant to 2.0
3d1b521b5be79913a020e373bf033657d4117d40Mark Andrews - misc/rewriteguide.html - needs cleaning in 1.3 and 2.0
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt - misc/known_client_problems.html - mostly ancient
3d1b521b5be79913a020e373bf033657d4117d40Mark Andrews- New build process.
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt - install.html has had a first-pass rewrite, but many things have
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt changed in the build system since it was written.
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt- Documentation of new features.
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt - This will probably require more input from new-httpd, since
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt not many people here follow the development process close
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt enough to know what is going on.
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt- API documentation
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt Status: Ben Laurie has written some hooks documentation
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt- Translations
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt There are several efforts underway to translate the documentation
86f221492f6f6b71c1114e3edba7373aa93d906bMark Andrews into other languages. A detailed list of the currently known
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt translators (and the corresponding websites) can be found at
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt http://httpd.apache.org/docs-project/translations.html
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan HuntNew User documentation
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt======================
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt* Directory Handling (mod_dir/mod_autoindex/etc)
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt* Sections (<Directory>/<Files>/<Location>)
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt - I think this should be a priority. A rewrite of /sections.html would
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt be a good place to start. That document is too technical and
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt insufficiently verbose for the average user.
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan HuntDocumentation improvements
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt==========================
86f221492f6f6b71c1114e3edba7373aa93d906bMark Andrews* Improving the "security docs"
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt - More content and better organisation.
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt* General cleaning and improving of module docs
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt* Making the directive definitions "less terse" (i.e., adding more
86f221492f6f6b71c1114e3edba7373aa93d906bMark Andrews examples and details to the definitions of the directives)
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt - We'll need to audit these and find out which ones need munging, as
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt some of it looks ok. --jsl
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt* Making site-specific enhancements easier, including a documented
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt and robust way for 3P module docco to be added -- and have it
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt survive a server docco upgrade
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt - This could be something a simple and hackish as a manual/extra/
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt directory (a la the 1.3 src/modules/extra/ directory) and a
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt script in the support directory that scans the files there and
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt updates the manual indices. (We do something like that now for
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt httpd.conf file with apxs [LoadModule, etc.].)
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt* regex: We should at least document someplace what regex library we
86f221492f6f6b71c1114e3edba7373aa93d906bMark Andrews are using and how to find more information about it