1072N/AApache HTTP Server Trunk Documentation Status File.
1072N/AFor more information on how to contribute to the Apache Documentation
1072N/A ------------------------------
1072N/A- The 1.3 docs need to have links from each directive forward to the
1072N/A might be done. This is a large undertaking, and involves a lot of
1072N/A grunt work, but will be greatly appreciated by the folks that make it
1072N/A to the wrong doc via Google. (Update: This is clearly going to take
1072N/A many months of effort, due to the volume of work and the mind-numbing
1072N/A document to be useful. In particular:
1072N/A - Document the various macros that can be used in documents.
1072N/A - Document the translation process.
1072N/A - Generally update it to make it reflect the current reality of how
1072N/A - Improving the documentation of the documentations' build system
1072N/A itself (requirements, procedures)
1072N/A- Identify which documents are grossly out of date, and fix.
1072N/A- The FAQ never amounted to much. Review the current FAQ, which is
1072N/A 1.3-era, and bring it into this century. (RBowen - I've copied the FAQ
1072N/A there. Consensus seems to be that this should be its new home.)
1072N/A- Security docs are unhelpful, and assume that the reader knows nothing.
1072N/A Need something a little more advanced, which either discusses
1072N/A application-level security, or links to something that does. I'm not
1072N/A even sure what to say needs done. Can we get someone to elaborate on
1072N/A what, exactly, needs written? Ivan Ristic has said maybe he would be
1072N/A - More content and better organisation
1072N/A - mod_dav resources are owned by the httpd. Perhaps write up the
1072N/A two-httpd dav setup covered in Rich Bowen's DAV Apachecon
1072N/A- Performance doc "drop-in replace" wikified by Igor from Sander's
1072N/A What's missing are reviews regarding statements made about Windows,
1072N/A a follow up -- these days it's *all* about scaling, really.
1072N/A - Bill Rowe is a good contact for tech questions.
1072N/A - "using apache" has been done, "compiling apache" is still open
1073N/A - hints on uninstalling apache (exit monitor, close directories,
1072N/A registry entries etc) (PR 10154)
1072N/A - FAQ: UTF-8 config and URL encoding for non-ascii characters.
1072N/A - Much clean-up and enhancement of aaa howto
1072N/A - Independent note on how to upgrade to new auth system
1072N/A - Discussion of DBD auth, and, in particular, examples of how to set
1072N/A up auth using each of the supported databases.
1072N/A- Expression syntax for <If>, Require expr, SetEnvIfExpr, CustomLog, ...
1072N/A - the follwing modules added since 2.2 lack documentation
1072N/A maybe some of the modules will not be included in 2.4
1072N/A - The following modules have new docs added since 2.2, but are
1072N/A grossly lacking in details and examples.
1072N/A - mod_suexec: very little documentation
1072N/A - mod_rewrite: explain, when which variables are actually available
1072N/A- mod_substitute and reverse proxies: Add example using mod_filter
1072N/A - explain what the following command line options do
1370N/A process handling the requests in a single loop?
1072N/A- Individual docs will need some cleanup.
1072N/A -
dso.xml - Reads as though this is a nifty new thing we just came
1072N/A - Ben Laurie has written some hooks documentation
1072N/A - authn provider API documentation could be useful
1072N/A- SSL docs need serious update and enhancement
1072N/A - no basic how to setup ssl doc
1072N/A mads said he was working on this, but...
1072N/A- Missing documentation for the support program checkgid
1072N/A - New index: directives by context, including listing which directives
1370N/A are available for each AllowOverride setting.
1072N/A - New index: backout modules by type (aaa, mappers, loggers etc.)
1370N/A probably by introducing a <category> element in modulesynopsis
1072N/A - Use a tag like <var> in place of <em> for things like the
1072N/A - add letter links to glossary and quickreference,
1072N/A perhaps also a term overview (sidebar)
1072N/A - remove <pre> elements. Use <br /> and <indent> elements to get
1072N/A- Provide example solutions for the mapping of encodings, especially
1072N/A for .gz etc. (also in regard to our default configuration)
1072N/A- How-To style documents for more of the daily tasks
1072N/A - Logging, log rotation, and log reporting
1072N/A - Secure mod_dav configuration
1072N/A- Writing modules - Can we provide a basic intro to writing modules,
1072N/A perhaps based around mod_example, or one of the other simple example
1072N/A - API docs are generated via 'make dox'. Find somewhere that we can
1072N/A do this on a schedule, and link to that from the documentation.
1072N/A - Introductory module authoring doc
1072N/A - Verify links to external resources at least every year
1072N/A- Update the list of translations at
1072N/A are accurate, and others are way outdated.
1072N/A- I'd like to expand the discussion of conditional logging, and add a
1072N/A- Is it worth having a doc that discusses recommended (what does this
1072N/A mean?) third-party modules like mod_security, mod_php, and so on - the
1072N/A things that we all assume everyone uses, but some folks might not know
1469N/A- Clarify which directives only affect requests when they're handled
1072N/A by the default handler. (
e.g. ForceType, TraceEnable, etc.)
1072N/A- Order directives alphabetically. Some modules, particularly in
1122N/A translations, have directives in random order, rather than
and determine which directives are missing from the translation docs.
Add them. This makes them show up in the directives listing for that
language, and also encourages translators to provide translations for
- Write a script that generates a table of modules and available
translations. Put this on the docs-project website.
- 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.