STATUS revision 9a95ec804ca8d5ec0d34ce9132cd6878ac388ea3
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williamsApache HTTP Server Trunk Documentation Status File.
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williamsLast modified: $Date$
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williamsFor more information on how to contribute to the Apache Documentation
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williamsProject, please see http://httpd.apache.org/docs-project/ and
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williamshttp://httpd.apache.org/docs-project/docsformat.html
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams ------------------------------
3437829f938dbb44527d91fbbc5f430a1243c5a5JnRouvignac=======================
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams- The dns-caveats document is largely rubbish, and needs to be
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams completely rewritten. Many of the points stopped being true over a
3437829f938dbb44527d91fbbc5f430a1243c5a5JnRouvignac- The 1.3 docs need to have links from each directive forward to the
3437829f938dbb44527d91fbbc5f430a1243c5a5JnRouvignac /docs/current/ version of that directive, or a note that it's not
3437829f938dbb44527d91fbbc5f430a1243c5a5JnRouvignac avaialble in this century. See core.html for examples of how this
3437829f938dbb44527d91fbbc5f430a1243c5a5JnRouvignac might be done. This is a large undertaking, and involves a lot of
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams grunt work, but will be greatly appreciated by the folks that make it
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams to the wrong doc via Google.
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams- Adding to the discussion of conditional logging, which I think
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams could be turned into more of a howto than the one paragraph it's
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams- Update the http://httpd.apache.org/docs-project/docsformat.html
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams document to be useful. In particular:
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - Document the various macros that can be used in documents.
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - Document the translation process.
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - Generally update it to make it reflect the current reality of how
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - Improving the documentation of the documentations' build system
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams itself (requirements, procedures)
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams- Identify which documents are grossly out of date, and fix.
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams- The FAQ never amounted to much. Review the current FAQ, which is
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams 1.3-era, and bring it into this century. (RBowen - I've copied the FAQ
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams into the wiki at http://wiki.apache.org/httpd/FAQ and am editing it
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams there. Consensus seems to be that this should be its new home.)
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams- Security docs are unhelpful, and assume that the reader knows nothing.
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams Need something a little more advanced, which either discusses
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams application-level security, or links to something that does. I'm not
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams even sure what to say needs done. Can we get someone to elaborate on
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams what, exactly, needs written? Ivan Ristic has said maybe he would be
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams willing to contribute.
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - More content and better organisation
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - mod_dav resources are owned by the httpd. Perhaps write up the
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams two-httpd dav setup covered in Rich Bowen's DAV Apachecon
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams presentation.
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams- Performance doc is way too low-level. Several people have said that
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams they might help out here, but it's a significant undertaking, and more
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams than a little daunting.
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams- Windows platform docs are in desperate need of rewrites/updates for 2.x.
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - Bill Rowe and Bill Stoddard are good contacts for tech questions.
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - "using apache" has been done, "compiling apache" is still open
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - hints on uninstalling apache (exit monitor, close directories,
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams registry entries etc) (PR 10154)
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - FAQ: UTF-8 config and URL encoding for non-ascii characters.
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams- New Auth system
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - Much clean-up and enhancement of aaa howto
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - Independent note on how to upgrade to new auth system
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - Discussion of DBD auth, and, in particular, examples of how to set
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams up auth using each of the supported databases.
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams- modules docs
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - the follwing modules added since 2.2 lack documentation
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - mod_watchdog
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - mod_heartbeat
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - mod_heartmonitor
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - mod_lbmethod_bybusyness
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - mod_lbmethod_byrequests
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - mod_lbmethod_bytraffic
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - mod_lbmethod_heartbeat
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - mod_socache_dbm
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - mod_socache_memcache
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - mod_socache_shmcb
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams the list may be incomplete
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams maybe some of the modules will not be included in 2.4
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - The following modules have new docs added since 2.2, but are
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams grossly lacking in details and examples.
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - mod_suexec: very little documentation
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - mod_rewrite: explain, when which variables are actually available
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams- MPM documentation
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - explain what the following command line options do
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams (perhaps in the developer/debugging docs):
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams -D ONE_PROCESS
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams one-process-mode == no threads, i.e. only one
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams process handling the requests in a single loop?
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams- Individual docs will need some cleanup.
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - misc/rewriteguide.html - needs cleaning in 1.3 and 2.0
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - platform/ebcdic.xml - needs major rework for 2.0
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - dso.xml - Reads as though this is a nifty new thing we just came
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams up with recently.
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams- API documentation
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - Ben Laurie has written some hooks documentation
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - authn provider API documentation could be useful
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams- SSL docs need serious update and enhancement
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - compat docs are wrong
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - no basic how to setup ssl doc
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams mads said he was working on this, but...
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams- How does <Proxy> fit into sections.html?
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams- Missing documentation for the support program checkgid
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams- New user docs: Directory Handling (mod_dir/mod_autoindex/etc)
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams (draft available in wiki)
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams- Enhancements to the DTD/XSL:
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - New index: directives by context, including listing which directives
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams are available for each AllowOverride setting.
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - New index: backout modules by type (aaa, mappers, loggers etc.)
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams probably by introducing a <category> element in modulesynopsis
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - Use a tag like <var> in place of <em> for things like the
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams <syntax> listing.
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - in progress
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - add letter links to glossary and quickreference,
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams perhaps also a term overview (sidebar)
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - remove <pre> elements. Use <br /> and <indent> elements to get
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams a similar effect.
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams- Provide example solutions for the mapping of encodings, especially
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams for .gz etc. (also in regard to our default configuration)
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams- How-To style documents for more of the daily tasks
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - Logging, log rotation, and log reporting
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - Secure mod_dav configuration
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams- Writing modules - Can we provide a basic intro to writing modules,
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams perhaps based around mod_example, or one of the other simple example
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams- http://httpd.apache.org/docs/trunk/developer/ is a graveyard, and a
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams profound embarrassment.
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - Purge all the dead links
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - API docs are generated via 'make dox'. Find somewhere that we can
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams do this on a schedule, and link to that from the documentation.
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - Introductory module authoring doc
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams - Verify links to external resources at least every year
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams- Update the list of translations at
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams http://httpd.apache.org/docs-project/translations.html Some of those
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams are accurate, and others are way outdated.
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams- I'd like to expand the discussion of conditional logging, and add a
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams few more useful exmaples.
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams That would be a good place to document logging of cache hit/miss:
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams https://issues.apache.org/bugzilla/show_bug.cgi?id=48241#c2
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams- Is it worth having a doc that discusses recommended (what does this
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams mean?) third-party modules like mod_security, mod_php, and so on - the
7d34efbc9a101a1180d1ed6e8bcda0c795648d48gary.williams things that we all assume everyone uses, but some folks might not know
There may be a license problem with the atbeginend.sty file, since