- mod_lua documentation with examples. (PQuerna has tentatively agreed
to give us an informal session on mod_lua in order to flesh out the
docs and put some force behind the notion that mod_lua can replace
- FAQ - Decide what to do with the FAQ - both the 1.3 FAQ and the
current FAQ, if in fact we still need one.
misleading information which seems to have accumulated over the years.
- Make the docs-project website more useful and actually welcoming of
- The dns-caveats document is largely rubbish, and needs to be
completely rewritten. Many of the points stopped being true over a
- The 1.3 docs need to have links from each directive forward to the
/docs/current/ version of that directive, or a note that it's not
avaialble in this century. See
core.html for examples of how this
might be done. This is a large undertaking, and involves a lot of
grunt work, but will be greatly appreciated by the folks that make it
to the wrong doc via Google. (Update: This is clearly going to take
many months of effort, due to the volume of work and the mind-numbing
- 1.3: Verify that the auto-generated link at the top of each module doc
goes to a valid 2.2 module - that is, find the modules that have
changed their names and in those cases hard-code the link to the
appropriate 2.2 docs (see mod_auth for example).
- Adding to the discussion of conditional logging, which I think
could be turned into more of a howto than the one paragraph it's
document to be useful. In particular:
- Document the various macros that can be used in documents.
- Document the translation process.
- Generally update it to make it reflect the current reality of how
- Improving the documentation of the documentations' build system
itself (requirements, procedures)
- Identify which documents are grossly out of date, and fix.
- The FAQ never amounted to much. Review the current FAQ, which is
1.3-era, and bring it into this century. (RBowen - I've copied the FAQ
there. Consensus seems to be that this should be its new home.)
- Security docs are unhelpful, and assume that the reader knows nothing.
Need something a little more advanced, which either discusses
application-level security, or links to something that does. I'm not
even sure what to say needs done. Can we get someone to elaborate on
what, exactly, needs written? Ivan Ristic has said maybe he would be
- More content and better organisation
- mod_dav resources are owned by the httpd. Perhaps write up the
two-httpd dav setup covered in Rich Bowen's DAV Apachecon
- Performance doc is way too low-level. Several people have said that
they might help out here, but it's a significant undertaking, and more
- Bill Rowe and Bill Stoddard are good contacts for tech questions.
- "using apache" has been done, "compiling apache" is still open
- hints on uninstalling apache (exit monitor, close directories,
registry entries etc) (PR 10154)
- FAQ: UTF-8 config and URL encoding for non-ascii characters.
- Much clean-up and enhancement of aaa howto
- Independent note on how to upgrade to new auth system
- Discussion of DBD auth, and, in particular, examples of how to set
up auth using each of the supported databases.
- the follwing modules added since 2.2 lack documentation
- mod_lbmethod_bybusyness
- mod_lbmethod_byrequests
the list may be incomplete
maybe some of the modules will not be included in 2.4
- The following modules have new docs added since 2.2, but are
grossly lacking in details and examples.
- mod_suexec: very little documentation
- mod_rewrite: explain, when which variables are actually available
- mod_substitute and reverse proxies: Add example using mod_filter
- explain what the following command line options do
one-process-mode == no threads,
i.e. only one
process handling the requests in a single loop?
- Individual docs will need some cleanup.
-
dso.xml - Reads as though this is a nifty new thing we just came
- Ben Laurie has written some hooks documentation
- authn provider API documentation could be useful
- SSL docs need serious update and enhancement
- no basic how to setup ssl doc
mads said he was working on this, but...
- Missing documentation for the support program checkgid
(draft available in wiki)
- New index: directives by context, including listing which directives
are available for each AllowOverride setting.
- New index: backout modules by type (aaa, mappers, loggers etc.)
probably by introducing a <category> element in modulesynopsis
- Use a tag like <var> in place of <em> for things like the
- add letter links to glossary and quickreference,
perhaps also a term overview (sidebar)
- remove <pre> elements. Use <br /> and <indent> elements to get
- Provide example solutions for the mapping of encodings, especially
for .gz etc. (also in regard to our default configuration)
- How-To style documents for more of the daily tasks
- Logging, log rotation, and log reporting
- Secure mod_dav configuration
- Writing modules - Can we provide a basic intro to writing modules,
perhaps based around mod_example, or one of the other simple example
- Purge all the dead links
- API docs are generated via 'make dox'. Find somewhere that we can
do this on a schedule, and link to that from the documentation.
- Introductory module authoring doc
- Verify links to external resources at least every year
- Update the list of translations at
are accurate, and others are way outdated.
- I'd like to expand the discussion of conditional logging, and add a
few more useful exmaples.
That would be a good place to document logging of cache
hit/miss:
- Is it worth having a doc that discusses recommended (what does this
mean?) third-party modules like mod_security, mod_php, and so on - the
things that we all assume everyone uses, but some folks might not know
- Clarify which directives only affect requests when they're handled
by the default handler. (
e.g. ForceType, TraceEnable, etc.)
- Dozens of other little problems with presentation, cross-referencing,
- Cleanup xsl to make it more readable. Almost everything
latex style files rarely have explict licenses. At worst, we can
drop this and manually adjust the relevant spacing.
- Reduce the size of the pdf (both bytes and pages) in any way possible.