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