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 -Mod auth spanish doc add the following that a community member has created.
  67 https://github.com/valenbg1/auth-example-mod-apache
  68
  69 - MPM documentation
  70      - explain what the following command line options do
  71        (perhaps in the developer/debugging docs):
  72         -D DEBUG
  73         -D ONE_PROCESS -- is this the same as -X, if not, should it be?
  74               one-process-mode == no threads, i.e. only one
  75               process handling the requests in a single loop?
  76
  77 - Identify which documents are grossly out of date, and fix.
  78      - platform/ebcdic.xml - needs major rework for 2.0
  79      - SSL docs need serious update and enhancement
  80         - compat docs are wrong
  81         - A basic how to has been started here:
  82             http://wiki.apache.org/httpd/SettingUpModSSL
  83             but it needs some work...
  84         - http://blag.esotericsystems.at/2011/01/answering-trivial-and-interesting-questions-with-openssl/
  85           looks like a good starting point for overhauling the FAQ, and
  86           has been placed at our disposal by the author.
  87
  88 - API documentation
  89     - Ben Laurie has written some hooks documentation
  90     - authn provider API documentation could be useful
  91
  92 - How does <Proxy> fit into sections.html?
  93
  94 - Missing documentation for the support program checkgid
  95
  96 - New user docs: Directory Handling (mod_dir/mod_autoindex/etc)
  97   (draft available in wiki)
  98
  99 - Enhancements to the DTD/XSL:
 100   - New index: directives by context, including listing which directives
 101     are available for each AllowOverride setting.
 102   - New index: backout modules by type (aaa, mappers, loggers etc.)
 103     probably by introducing a <category> element in modulesynopsis
 104   - Use a tag like <var> in place of <em> for things like the
 105     <syntax> listing.
 106     - in progress
 107   - add letter links to glossary and quickreference,
 108     perhaps also a term overview (sidebar)
 109
 110 - Provide example solutions for the mapping of encodings, especially
 111   for .gz etc. (also in regard to our default configuration)
 112
 113 - How-To style documents for more of the daily tasks
 114     - Logging, log rotation, and log reporting
 115     - Secure mod_dav configuration
 116
 117 - http://httpd.apache.org/docs/trunk/developer/ is a graveyard, and a
 118   profound embarrassment.
 119     - Purge all the dead links
 120     - Verify links to external resources at least every year
 121
 122 - Update the list of translations at
 123   http://httpd.apache.org/docs-project/translations.html  Some of those
 124   are accurate, and others are way outdated.
 125
 126 - I'd like to expand the discussion of conditional logging, and add a
 127   few more useful exmaples.
 128   That would be a good place to document logging of cache hit/miss:
 129   https://issues.apache.org/bugzilla/show_bug.cgi?id=48241#c2
 130
 131 - Is it worth having a doc that discusses recommended (what does this
 132   mean?) third-party modules like mod_security, mod_php, and so on - the
 133   things that we all assume everyone uses, but some folks might not know
 134   about.
 135
 136 - Clarify which directives only affect requests when they're handled
 137   by the default handler.  (e.g. ForceType, TraceEnable, etc.)
 138
 139 - Add examples using expr to mod_rewrite recipes. Possibly benchmark the
 140   different approaches and make intelligent remarks about the
 141   comparative value of each.
 142
 143 - Fix this error message:
 144     Request exceeded the limit of 10 internal redirects due to probable
 145     configuration error. Use 'LimitInternalRecursion' to increase the limit
 146     if necessary. Use 'LogLevel debug' to get a backtrace.
 147   This error message is often returned when a RewriteRule loops, in
 148   which case setting LimitInternalRecursion won't do anything towards
 149   fixing the problem. However, the error message is already very long.
 150   Thoughts?
 151
 152 - Examples in Rewrite Flags doc for QSD, Redirect, Chain, DPI, END, NS
 153
 154 - Error codes
 155     Decide how and where to document the error codes (AH****), and then
 156     start on doing it.
 157
 158 - If someone has xslt and LaTeX skills, they could consider getting the
 159   xml->LaTeX->PDF build chain working again. See specifically
 160   https://issues.apache.org/bugzilla/show_bug.cgi?id=45526 for details
 161   of what's broken. For the moment, PDF docs are no longer referenced on
 162   the docs site.
 163
 164 - Add example of using -p flag to rotatelogs to do something useful.
 165
 166 - Log rotation doc - http://httpd.apache.org/docs/2.4/logs.html#rotation
 167   needs to mention rotatelogs as well as fairly standard log rotation
 168   stuff, rather than encouraging people to do this by hand.
 169