STATUS revision 9dc3a3175ef06a2a1d2fee616dfbd283b494be60
3331475701a5b12f98b3cfea07d5dca60072530fvboxsyncApache HTTP Server 2.1 Documentation Status File.
3331475701a5b12f98b3cfea07d5dca60072530fvboxsyncLast modified: $Date: 2003/06/01 21:11:05 $
3331475701a5b12f98b3cfea07d5dca60072530fvboxsyncFor more information on how to contribute to the Apache Documentation
3331475701a5b12f98b3cfea07d5dca60072530fvboxsyncProject, please see http://httpd.apache.org/docs-project/
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync ------------------------------
3331475701a5b12f98b3cfea07d5dca60072530fvboxsyncDecisions pending
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync=================
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync- Figure out what to do about the 2.0 FAQ
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync - Copy important stuff from 1.3?
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync - Some kind of XML?
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync - Perhaps we can use the newly created Wiki for this. (SubWiki,
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync with the possibility to get nice commit mails.)
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync nd: someone should try to convince me, what the heck is
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync so cool with wikis
7c63dd76442a4896af6ce9c65d87461d3e7fe82bvboxsync erik: it lowers the entry barrier and therefore users are able
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync to contribute without all the build hassles (see PHP site)
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync nd: yes, good bad example. The PHP docs would mostly be
7c63dd76442a4896af6ce9c65d87461d3e7fe82bvboxsync better without these comments. I don't want to censor
7c63dd76442a4896af6ce9c65d87461d3e7fe82bvboxsync the entries, but also don't want to leave them without
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync control. IMHO it's better to incorporate changes into the
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync static docs. We need some better way of feedback, anyway.
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync erik: yes, the plan could be to have the wiki as some sort of
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync scratch_pad (clearly stated on the relevant pages) and
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync finally incorporate the useful info in it into the static
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync documentation
3331475701a5b12f98b3cfea07d5dca60072530fvboxsyncThings That Need Fixing
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync=======================
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync- Windows platform docs are in desperate need of rewrites/updates for 2.0.
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync - Bill Rowe and Bill Stoddard are good contacts for tech questions.
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync - "using apache" has been done, "compiling apache" is still open
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync - hints on uninstalling apache (exit monitor, close directories,
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync registry entries etc) (PR 10154)
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync - FAQ! UTF-8 config and URL encoding for non-ascii characters.
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync- New Auth system
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync - Much clean-up and enhancement of aaa howto
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync - Independent note on how to upgrade to new auth system
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync- modules docs
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync - mod_suexec: very little documentation
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync - mod_proxy: updates for 2.0
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync - mod_status: updates for 2.0
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync - mod_example: updates for 2.0
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync - mod_rewrite: explain, when what variables are actually available
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync- MPM documentation
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync - explain what the following command line options do
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync (perhaps in the developer/debugging docs):
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync -D ONE_PROCESS
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync one-process-mode == no threads, i.e. only one
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync process handling the requests in a single loop?
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync -D NO_DETACH (not in every MPM avail.)
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync no daemon, but detached from terminal?
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync -D FOREGROUND (not in every MPM avail.)
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync- Individual docs will need some cleanup.
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync - misc/custom_errordocs.html needs to be updated to
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync essentially describe how the international error
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync docs included in 2.0 work
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync - misc/perf-tuning.html - needs major rewrite for 2.0
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync - misc/rewriteguide.html - needs cleaning in 1.3 and 2.0
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync - platform/ebcdic.xml - needs major rework for 2.0
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync- New build process.
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync - install.html has had a first-pass rewrite, it is basically
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync accurate, but very incomplete: many configure options are missing,
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync especially those inherited from apr.
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync- API documentation
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync - Ben Laurie has written some hooks documentation
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync - authn provider API documentation could be useful
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync- Several features in Apache require write-access to the filesystem.
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync Examples: CacheRoot, DavLockDB, ScriptLog
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync We should treat the things consistently in the docs, and perhaps
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync suggest the use of directory like /usr/local/apache2/var/ that is
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync httpd-writable.
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync- SSL docs are generally good, but they need a refreshing by someone
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync familiar with mod_ssl and openssl.
3331475701a5b12f98b3cfea07d5dca60072530fvboxsyncDocumentation improvements
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync==========================
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync* New user docs: Directory Handling (mod_dir/mod_autoindex/etc)
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync* Enhancements to the DTD/XSL:
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync - <glossary> tag that links to the glossary and uses some special
3331475701a5b12f98b3cfea07d5dca60072530fvboxsync style in the css.
7c63dd76442a4896af6ce9c65d87461d3e7fe82bvboxsync - New index: directives by context, including listing which directives
7c63dd76442a4896af6ce9c65d87461d3e7fe82bvboxsync are available for each AllowOverride setting.
7c63dd76442a4896af6ce9c65d87461d3e7fe82bvboxsync - New index: backout modules by type (aaa, mappers, loggers etc.)
7c63dd76442a4896af6ce9c65d87461d3e7fe82bvboxsync probably by introducing a <category> element in modulesynopsis
7c63dd76442a4896af6ce9c65d87461d3e7fe82bvboxsync - Use a tag like <var> in place of <em> for things like the
7c63dd76442a4896af6ce9c65d87461d3e7fe82bvboxsync <syntax> listing.
7c63dd76442a4896af6ce9c65d87461d3e7fe82bvboxsync - in progress
7c63dd76442a4896af6ce9c65d87461d3e7fe82bvboxsync - add letter links to glossary and quickreference,
7c63dd76442a4896af6ce9c65d87461d3e7fe82bvboxsync perhaps also a term overview (sidebar)
7c63dd76442a4896af6ce9c65d87461d3e7fe82bvboxsync - remove <pre> elements. Use <br /> and <indent> elements to get
7c63dd76442a4896af6ce9c65d87461d3e7fe82bvboxsync a similar effect.
7c63dd76442a4896af6ce9c65d87461d3e7fe82bvboxsync* Autogeneration of PDF
7c63dd76442a4896af6ce9c65d87461d3e7fe82bvboxsync - Andre is working on this, Erik volunteers to help out
7c63dd76442a4896af6ce9c65d87461d3e7fe82bvboxsync* Improving the documentation of the documentations' build system
7c63dd76442a4896af6ce9c65d87461d3e7fe82bvboxsync itself (requirements, procedures)
7c63dd76442a4896af6ce9c65d87461d3e7fe82bvboxsync* Improving the "security docs"
7c63dd76442a4896af6ce9c65d87461d3e7fe82bvboxsync - More content and better organisation
7c63dd76442a4896af6ce9c65d87461d3e7fe82bvboxsync - mod_dav ressources are owned by the httpd
7c63dd76442a4896af6ce9c65d87461d3e7fe82bvboxsync* General cleaning and improving of module docs
7c63dd76442a4896af6ce9c65d87461d3e7fe82bvboxsync* Making the directive definitions "less terse" (i.e., adding more
7c63dd76442a4896af6ce9c65d87461d3e7fe82bvboxsync examples and details to the definitions of the directives)
7c63dd76442a4896af6ce9c65d87461d3e7fe82bvboxsync* Making site-specific enhancements easier, including a documented
7c63dd76442a4896af6ce9c65d87461d3e7fe82bvboxsync and robust way for 3P module docco to be added -- and have it
7c63dd76442a4896af6ce9c65d87461d3e7fe82bvboxsync survive a server docco upgrade
7c63dd76442a4896af6ce9c65d87461d3e7fe82bvboxsync - This could be something a simple and hackish as a manual/extra/
7c63dd76442a4896af6ce9c65d87461d3e7fe82bvboxsync directory (a la the 1.3 src/modules/extra/ directory) and a
7c63dd76442a4896af6ce9c65d87461d3e7fe82bvboxsync script in the support directory that scans the files there and
7c63dd76442a4896af6ce9c65d87461d3e7fe82bvboxsync updates the manual indices. (We do something like that now for
7c63dd76442a4896af6ce9c65d87461d3e7fe82bvboxsync httpd.conf file with apxs [LoadModule, etc.].)
7c63dd76442a4896af6ce9c65d87461d3e7fe82bvboxsync* Summarize all the implemented drafts/standards with short explanations
7c63dd76442a4896af6ce9c65d87461d3e7fe82bvboxsync within a document. (PR 16938)
7c63dd76442a4896af6ce9c65d87461d3e7fe82bvboxsync* Provide example solutions for the mapping of encodings, especially
7c63dd76442a4896af6ce9c65d87461d3e7fe82bvboxsync for .gz etc. (also in regard to our default configuration)