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