granicus.if.org Git - apache/blob - docs/STATUS

   1 Apache HTTP Server Trunk Documentation Status File.  Last modified: $Date$
   2
   3 For more information on how to contribute to the Apache Documentation
   4 Project, please see http://httpd.apache.org/docs-project/ and
   5 http://httpd.apache.org/docs-project/docsformat.html
   6
   7               ------------------------------
   8
   9 To Do List
  10 =======================
  11
  12 - The following directives of modules included in 2.4.x are not documented:
  13   ProxyHTMLMeta (mod_proxy_html)
  14   SSLPKCS7CertificateFile (mod_ssl)
  15
  16 - Update the http://httpd.apache.org/docs-project/docsformat.html
  17   document to be useful. In particular:
  18     - Document the various macros that can be used in documents.
  19     - Document the translation process.
  20     - Generally update it to make it reflect the current reality of how
  21       we work.
  22     -  Improving the documentation of the documentations' build system
  23        itself (requirements, procedures)
  24
  25 - Continue to enhance the FAQ, which is in the wiki:
  26   http://wiki.apache.org/httpd/FAQ
  27
  28 - Security docs are unhelpful, and assume that the reader knows nothing.
  29   Need something a little more advanced, which either discusses
  30   application-level security, or links to something that does. I'm not
  31   even sure what to say needs done. Can we get someone to elaborate on
  32   what, exactly, needs written? Ivan Ristic has said maybe he would be
  33   willing to contribute.
  34   - More content and better organisation
  35   - mod_dav resources are owned by the httpd. Perhaps write up the
  36     two-httpd dav setup covered in Rich Bowen's DAV Apachecon
  37     presentation.
  38
  39 - Performance doc "drop-in replace" misc/perf-scaling.xml
  40   as well as: http://wiki.apache.org/httpd/PerformanceScalingOut
  41   They both need review and updates to reflect the current state
  42   of the art.
  43
  44 - Windows platform docs are in desperate need of rewrites/updates for 2.x.
  45     - Bill Rowe is a good contact for tech questions.
  46     - "using apache" has been done, "compiling apache" is still open
  47     - hints on uninstalling apache (exit monitor, close directories,
  48       registry entries etc) (PR 10154)
  49     - FAQ: UTF-8 config and URL encoding for non-ascii characters.
  50
  51 - New Auth system
  52     - Much clean-up and enhancement of aaa howto (Can someone clarify
  53       exactly what needs cleaned up and enhanced?)
  54     - Independent note on how to upgrade to new auth system
  55     - Discussion of DBD auth, and, in particular, examples of how to set
  56       up auth using each of the supported databases.
  57
  58 - Expression syntax for <If>, Require expr, SetEnvIfExpr, CustomLog, ...
  59   Start is in expr.xml, igalic is working on this
  60
  61 - modules docs
  62     - the following modules added since 2.2 lack documentation
  63         - mod_serf
  64         - mpm_simple
  65       the list may be incomplete
  66       maybe some of the modules will not be included in 2.4
  67     - mod_suexec: very little documentation
  68
  69 - mod_substitute and reverse proxies: Add example using mod_filter
  70   (see: http://marc.info/?l=apache-httpd-users&m=128830729603423&w=2)
  71
  72 - MPM documentation
  73      - explain what the following command line options do
  74        (perhaps in the developer/debugging docs):
  75         -D DEBUG
  76         -D ONE_PROCESS -- is this the same as -X, if not, should it be?
  77               one-process-mode == no threads, i.e. only one
  78               process handling the requests in a single loop?
  79
  80 - Identify which documents are grossly out of date, and fix.
  81      - platform/ebcdic.xml - needs major rework for 2.0
  82      - SSL docs need serious update and enhancement
  83         - compat docs are wrong
  84         - A basic how to has been started here:
  85             http://wiki.apache.org/httpd/SettingUpModSSL
  86             but it needs some work...
  87         - http://blag.esotericsystems.at/2011/01/answering-trivial-and-interesting-questions-with-openssl/
  88           looks like a good starting point for overhauling the FAQ, and
  89           has been placed at our disposal by the author.
  90
  91 - API documentation
  92     - Ben Laurie has written some hooks documentation
  93     - authn provider API documentation could be useful
  94
  95 - How does <Proxy> fit into sections.html?
  96
  97 - Missing documentation for the support program checkgid
  98
  99 - New user docs: Directory Handling (mod_dir/mod_autoindex/etc)
 100   (draft available in wiki)
 101
 102 - Enhancements to the DTD/XSL:
 103   - New index: directives by context, including listing which directives
 104     are available for each AllowOverride setting.
 105   - New index: backout modules by type (aaa, mappers, loggers etc.)
 106     probably by introducing a <category> element in modulesynopsis
 107   - Use a tag like <var> in place of <em> for things like the
 108     <syntax> listing.
 109     - in progress
 110   - add letter links to glossary and quickreference,
 111     perhaps also a term overview (sidebar)
 112
 113 - Provide example solutions for the mapping of encodings, especially
 114   for .gz etc. (also in regard to our default configuration)
 115
 116 - How-To style documents for more of the daily tasks
 117     - Logging, log rotation, and log reporting
 118     - Secure mod_dav configuration
 119
 120 - http://httpd.apache.org/docs/trunk/developer/ is a graveyard, and a
 121   profound embarrassment.
 122     - Purge all the dead links
 123     - Verify links to external resources at least every year
 124
 125 - Update the list of translations at
 126   http://httpd.apache.org/docs-project/translations.html  Some of those
 127   are accurate, and others are way outdated.
 128
 129 - I'd like to expand the discussion of conditional logging, and add a
 130   few more useful exmaples.
 131   That would be a good place to document logging of cache hit/miss:
 132   https://issues.apache.org/bugzilla/show_bug.cgi?id=48241#c2
 133
 134 - Is it worth having a doc that discusses recommended (what does this
 135   mean?) third-party modules like mod_security, mod_php, and so on - the
 136   things that we all assume everyone uses, but some folks might not know
 137   about.
 138
 139 - Clarify which directives only affect requests when they're handled
 140   by the default handler.  (e.g. ForceType, TraceEnable, etc.)
 141
 142 - Add examples using expr to mod_rewrite recipes. Possibly benchmark the
 143   different approaches and make intelligent remarks about the
 144   comparative value of each.
 145
 146 - Fix this error message:
 147     Request exceeded the limit of 10 internal redirects due to probable
 148     configuration error. Use 'LimitInternalRecursion' to increase the limit
 149     if necessary. Use 'LogLevel debug' to get a backtrace.
 150   This error message is often returned when a RewriteRUle loops, in
 151   which case setting LimitInternalRecursion won't do anything towards
 152   fixing the problem. However, the error message is already very long.
 153   Thoughts?
 154
 155 - Error codes
 156     Decide how and where to document the error codes (AH****), and then
 157     start on doing it.
 158
 159 - If someone has xslt and LaTeX skills, they could consider getting the
 160   xml->LaTeX->PDF build chain working again. See specifically
 161   https://issues.apache.org/bugzilla/show_bug.cgi?id=45526 for details
 162   of what's broken. For the moment, PDF docs are no longer referenced on
 163   the docs site.
 164
 165