STATUS revision e50da9a6c8818b61442dcdae4ba2067ebdd07dee
906N/AApache HTTP Server 2.1 Documentation Status File.
906N/ALast modified: $Date: 2003/05/29 11:56:04 $
906N/A
906N/AFor more information on how to contribute to the Apache Documentation
906N/AProject, please see http://httpd.apache.org/docs-project/
906N/A
906N/A ------------------------------
906N/A
906N/ADecisions pending
906N/A=================
906N/A
906N/A - Backport removal of SSI from docs directory in default config
906N/A docs/conf/httpd-std.conf.in rev 1.36
906N/A docs/conf/httpd-win.conf rev 1.82
906N/A +1: slive, nd, kess
906N/A
906N/A -Comment out .gz etc. AddEncoding lines in our default configuration.
906N/A docs/conf/httpd-std.conf.in rev 1.32
906N/A jerenkrantz said in the log message:
906N/A Current browsers have a tendency to decompress the data when no one
906N/A really wants it to do that. If you want the old behavior that leads to
3595N/A transparent decompression by modern browsers, uncomment these lines.
906N/A But, this shouldn't be our default.
906N/A Someone else said: Certainly wasn't in 1.3.
3817N/A nd adds: we should provide example solutions somewhere in the docs.
3817N/A e.g.: .tar.gz should get the content-type application/x-gzip
906N/A (hmm, bad x-, better suggestions?).
906N/A <Files *.tar.gz>
906N/A Forcetype ...
4260N/A </Files>
1799N/A
1799N/A - Backport to 2.0
906N/A +1: wrowe, slive, nd
906N/A
4260N/A- Figure out what to do about the 2.0 FAQ
1799N/A - Copy important stuff from 1.3?
1799N/A - Some kind of XML?
906N/A - Something that allows dynamic contributions from users a la
4260N/A FAQ-O-Matic? (I don't think any really good software exists
2899N/A for this.)
1389N/A - Perhaps we can use the newly created Wiki for this. (SubWiki,
1389N/A with the possibility to get nice commit mails.)
2410N/A nd: someone should try to convince me, what the heck is
906N/A so cool with wikis
3936N/A erik: it lowers the entry barrier and therefore users are able to
3936N/A contribute (handy for a FAQ, see PHP site)
3936N/A nd: yes, good bad example. The PHP docs would mostly be
3936N/A better without these comments. I don't want to censor
3470N/A the entries, but also don't want to leave them without
4744N/A control. IMHO it's better to incorporate changes into the
4744N/A static docs. We need some better way of feedback, anyway.
3817N/A
3817N/AThings That Need Fixing
3817N/A=======================
906N/A
3703N/A- Windows platform docs are in desperate need of rewrites/updates for 2.0.
4744N/A - Bill Rowe and Bill Stoddard are good contacts for tech questions.
3703N/A - "using apache" has been done, "compiling apache" is still open
3703N/A - hints on uninstalling apache (exit monitor, close directories,
4744N/A registry entries etc) (PR 10154)
3703N/A - FAQ! UTF-8 config and URL encoding for non-ascii characters.
1389N/A
906N/A- New Auth system
906N/A - Much clean-up and enhancement of aaa howto
906N/A - Independent note on how to upgrade to new auth system
906N/A
3470N/A- modules docs
3470N/A - mod_suexec: very little documentation
3470N/A - mod_proxy: updates for 2.0
3470N/A - mod_status: updates for 2.0
3470N/A - mod_example: updates for 2.0
3470N/A - mod_rewrite: explain, when what variables are actually available
3470N/A (PR 16402)
3470N/A
3470N/A- man pages
3470N/A - Convert from nroff to our xml format. See list at bottom.
3470N/A - Then if someone gets creative, they can try to find an automatic
3595N/A way to convert back to nroff.
3470N/A - An example: http://cyberelk.net/tim/data/xmlto/db2man/
3470N/A This is designed for docbook, but it could be adapted.
3775N/A I'm not sure what the license is.
3775N/A
3775N/A- MPM documentation
3775N/A - explain what the following command line options do
3470N/A (perhaps in the developer/debugging docs):
906N/A -D DEBUG
1389N/A -D ONE_PROCESS
1389N/A one-process-mode == no threads, i.e. only one
1389N/A process handling the requests in a single loop?
906N/A -D NO_DETACH (not in every MPM avail.)
3703N/A no daemon, but detached from terminal?
3703N/A -D FOREGROUND (not in every MPM avail.)
3703N/A ?
3703N/A
906N/A- Individual docs will need some cleanup.
906N/A - misc/custom_errordocs.html needs to be updated to
1389N/A essentially describe how the international error
1799N/A docs included in 2.0 work
906N/A - misc/perf-tuning.html - needs major rewrite for 2.0
906N/A - misc/rewriteguide.html - needs cleaning in 1.3 and 2.0
906N/A - platform/ebcdic.xml - needs major rework for 2.0
4689N/A
906N/A- New build process.
2494N/A - install.html has had a first-pass rewrite, it is basically
2494N/A accurate, but very incomplete: many configure options are missing,
3703N/A especially those inherited from apr.
3703N/A
3470N/A- API documentation
3703N/A - Ben Laurie has written some hooks documentation
3703N/A - authn provider API documentation could be useful
906N/A
3703N/A- Several features in Apache require write-access to the filesystem.
3703N/A Examples: CacheRoot, DavLockDB, ScriptLog
3703N/A We should treat the things consistently in the docs, and perhaps
2494N/A suggest the use of directory like /usr/local/apache2/var/ that is
2494N/A httpd-writable.
906N/A
3703N/A- SSL docs are generally good, but they need a refreshing by someone
906N/A familiar with mod_ssl and openssl.
4337N/A
4337N/ADocumentation improvements
3817N/A==========================
3817N/A
3817N/A* New user docs: Directory Handling (mod_dir/mod_autoindex/etc)
3817N/A
3817N/A* Enhancements to the DTD/XSL:
3817N/A - <glossary> tag that links to the glossary and uses some special
3817N/A style in the css.
3817N/A - New index: directives by context, including listing which directives
3817N/A are available for each AllowOverride setting.
4744N/A - New index: backout modules by type (aaa, mappers, loggers etc.)
3817N/A probably by introducing a <category> element in modulesynopsis
3817N/A - Use a tag like <var> in place of <em> for things like the
3817N/A <syntax> listing.
3817N/A - in progress
3817N/A - add letter links to glossary and quickreference,
3817N/A perhaps also a term overview (sidebar)
3817N/A - cross references between the different languages,
3817N/A at least links from non-en docs to the originals.
3817N/A - Javascript?
4689N/A - post processing (s&r, XML::Parser, ...)?
3817N/A - pre processing ([kind of] type maps
3817N/A generated from sitemap entries like:
<page><variant lang="en" href="">title</variant>)?
- looking for other good ideas ;-)
- remove <pre> elements. Use <br /> and <indent> elements to get
a similar effect.
* Autogeneration of PDF
- Andr� is working on this, Erik volunteers to help out
* Improving the "security docs"
- More content and better organisation.
- mod_dav ressources are owned by the httpd
* General cleaning and improving of module docs
* Making the directive definitions "less terse" (i.e., adding more
examples and details to the definitions of the directives)
* Making site-specific enhancements easier, including a documented
and robust way for 3P module docco to be added -- and have it
survive a server docco upgrade
- This could be something a simple and hackish as a manual/extra/
directory (a la the 1.3 src/modules/extra/ directory) and a
script in the support directory that scans the files there and
updates the manual indices. (We do something like that now for
httpd.conf file with apxs [LoadModule, etc.].)
* Summarize all the implemented drafts/standards with short explanations
within a document. (PR 16938)