2N/AApache HTTP Server Trunk Documentation Status File.
2N/ALast modified: $Date$
2N/AFor more information on how to contribute to the Apache Documentation
2N/A ------------------------------
2N/A=======================
2N/A- The dns-caveats document is largely rubbish, and needs to be
2N/A completely rewritten. Many of the points stopped being true over a
2N/A- Rewriting the custom-error document, which is grossly outdated.
2N/A- Adding to the discussion of conditional logging, which I think
2N/A could be turned into more of a howto than the one paragraph it's
2N/A document to be useful. In particular:
2N/A - Document the various macros that can be used in documents.
2N/A - Document the translation process.
2N/A - Generally update it to make it reflect the current reality of how
2N/A - Improving the documentation of the documentations' build system
2N/A itself (requirements, procedures)
2N/A- Identify which documents are grossly out of date, and fix.
2N/A- The FAQ never amounted to much. Review the current FAQ, which is
2N/A 1.3-era, and bring it into this century.
2N/A- Security docs are unhelpful, and assume that the reader knows nothing.
2N/A Need something a little more advanced, which either discusses
2N/A application-level security, or links to something that does. I'm not
2N/A even sure what to say needs done. Can we get someone to elaborate on
2N/A what, exactly, needs written? Ivan Ristic has said maybe he would be
2N/A willing to contribute.
2N/A - More content and better organisation
2N/A - mod_dav resources are owned by the httpd. Perhaps write up the
2N/A two-httpd dav setup covered in Rich Bowen's DAV Apachecon
2N/A- Performance doc is way too low-level. Several people have said that
2N/A they might help out here, but it's a significant undertaking, and more
2N/A than a little daunting.
2N/A - Bill Rowe and Bill Stoddard are good contacts for tech questions.
2N/A - "using apache" has been done, "compiling apache" is still open
2N/A - hints on uninstalling apache (exit monitor, close directories,
2N/A registry entries etc) (PR 10154)
2N/A - FAQ: UTF-8 config and URL encoding for non-ascii characters.
2N/A - Much clean-up and enhancement of aaa howto
2N/A - Independent note on how to upgrade to new auth system
2N/A - Discussion of DBD auth, and, in particular, examples of how to set
2N/A up auth using each of the supported databases.
2N/A - the follwing modules added since 2.2 lack documentation
2N/A - mod_lbmethod_bybusyness
2N/A - mod_lbmethod_byrequests
2N/A - mod_lbmethod_bytraffic
2N/A - mod_lbmethod_heartbeat
2N/A - mod_socache_memcache
2N/A the list may be incomplete
2N/A maybe some of the modules will not be included in 2.4
2N/A - The following modules have new docs added since 2.2, but are
2N/A grossly lacking in details and examples.
2N/A - mod_suexec: very little documentation
2N/A - mod_rewrite: explain, when which variables are actually available
2N/A - explain what the following command line options do
2N/A one-process-mode == no threads,
i.e. only one
2N/A process handling the requests in a single loop?
2N/A- Individual docs will need some cleanup.
2N/A -
dso.xml - Reads as though this is a nifty new thing we just came
2N/A - Ben Laurie has written some hooks documentation
2N/A - authn provider API documentation could be useful
2N/A- SSL docs need serious update and enhancement
2N/A - compat docs are wrong
2N/A - no basic how to setup ssl doc
2N/A mads said he was working on this, but...
2N/A- Missing documentation for the support program checkgid
2N/A (draft available in wiki)
2N/A - New index: directives by context, including listing which directives
2N/A are available for each AllowOverride setting.
2N/A - New index: backout modules by type (aaa, mappers, loggers etc.)
2N/A probably by introducing a <category> element in modulesynopsis
2N/A - Use a tag like <var> in place of <em> for things like the
2N/A - add letter links to glossary and quickreference,
2N/A perhaps also a term overview (sidebar)
2N/A - remove <pre> elements. Use <br /> and <indent> elements to get
2N/A- Provide example solutions for the mapping of encodings, especially
2N/A for .gz etc. (also in regard to our default configuration)
2N/A- How-To style documents for more of the daily tasks
2N/A - Logging, log rotation, and log reporting
2N/A- Writing modules - Can we provide a basic intro to writing modules,
2N/A perhaps based around mod_example, or one of the other simple example
2N/A profound embarrassment.
2N/A - Purge all the dead links
2N/A - API docs are generated via 'make dox'. Find somewhere that we can
2N/A do this on a schedule, and link to that from the documentation.
2N/A - Introductory module authoring doc
2N/A - Verify links to external resources at least every year
2N/A- Update the list of translations at
2N/A are accurate, and others are way outdated.
2N/A- I'd like to expand the discussion of conditional logging, and add a
2N/A few more useful exmaples.
2N/A That would be a good place to document logging of cache
hit/miss:
2N/A- The mod_usertrack docs should describe what the module does, now,
2N/A rather than spending so much time comparing it to what a long-gone
2N/A module, which our readers never used, used to do. Examples would be
2N/A helpful. Additionally, a significant part of the doc consists of a
2N/A quoted email message. This seems somewhat unprofessional.
2N/A- Dozens of other little problems with presentation, cross-referencing,
2N/A- Cleanup xsl to make it more readable. Almost everything
2N/A latex style files rarely have explict licenses. At worst, we can
2N/A drop this and manually adjust the relevant spacing.
2N/A- Reduce the size of the pdf (both bytes and pages) in any way possible.