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

   1 Apache HTTP Server Trunk Documentation Status File.
   2 Last modified: $Date$
   3
   4 For more information on how to contribute to the Apache Documentation
   5 Project, please see http://httpd.apache.org/docs-project/ and
   6 http://httpd.apache.org/docs-project/docsformat.html
   7
   8               ------------------------------
   9
  10 To Do List
  11 =======================
  12
  13 - The 1.3 docs need to have links from each directive forward to the
  14   /docs/current/ version of that directive, or a note that it's not
  15   avaialble in this century. See core.html for examples of how this
  16   might be done. This is a large undertaking, and involves a lot of
  17   grunt work, but will be greatly appreciated by the folks that make it
  18   to the wrong doc via Google. (Update: This is clearly going to take
  19   many months of effort, due to the volume of work and the mind-numbing
  20   tediousness.)
  21
  22 - Update the http://httpd.apache.org/docs-project/docsformat.html
  23   document to be useful. In particular:
  24     - Document the various macros that can be used in documents.
  25     - Document the translation process.
  26     - Generally update it to make it reflect the current reality of how
  27       we work.
  28     -  Improving the documentation of the documentations' build system
  29        itself (requirements, procedures)
  30
  31 - Continue to enhance the FAQ, which is in the wiki:
  32   http://wiki.apache.org/httpd/FAQ
  33
  34 - Security docs are unhelpful, and assume that the reader knows nothing.
  35   Need something a little more advanced, which either discusses
  36   application-level security, or links to something that does. I'm not
  37   even sure what to say needs done. Can we get someone to elaborate on
  38   what, exactly, needs written? Ivan Ristic has said maybe he would be
  39   willing to contribute.
  40   - More content and better organisation
  41   - mod_dav resources are owned by the httpd. Perhaps write up the
  42     two-httpd dav setup covered in Rich Bowen's DAV Apachecon
  43     presentation.
  44
  45 - Performance doc "drop-in replace" wikified by Igor from Sander's
  46   presentation: http://wiki.apache.org/httpd/PerformanceScalingUp
  47   What's missing are reviews regarding statements made about Windows,
  48   as well as: http://wiki.apache.org/httpd/PerformanceScalingOut for
  49   a follow up -- these days it's *all* about scaling, really.
  50
  51 - Windows platform docs are in desperate need of rewrites/updates for 2.x.
  52     - Bill Rowe is a good contact for tech questions.
  53     - "using apache" has been done, "compiling apache" is still open
  54     - hints on uninstalling apache (exit monitor, close directories,
  55       registry entries etc) (PR 10154)
  56     - FAQ: UTF-8 config and URL encoding for non-ascii characters.
  57
  58 - New Auth system
  59     - Much clean-up and enhancement of aaa howto (Can someone clarify
  60       exactly what needs cleaned up and enhanced?)
  61     - Independent note on how to upgrade to new auth system
  62     - Discussion of DBD auth, and, in particular, examples of how to set
  63       up auth using each of the supported databases.
  64
  65 - Expression syntax for <If>, Require expr, SetEnvIfExpr, CustomLog, ...
  66   Start is in expr.xml, igalic is working on this
  67
  68 - modules docs
  69     - the follwing modules added since 2.2 lack documentation
  70         - mod_serf
  71         - mod_watchdog
  72         - mod_heartbeat
  73         - mod_heartmonitor
  74         - mod_lbmethod_bybusyness
  75         - mod_lbmethod_byrequests
  76         - mod_lbmethod_bytraffic
  77         - mod_lbmethod_heartbeat
  78         - mod_socache_dbm
  79         - mod_socache_memcache
  80         - mod_socache_shmcb
  81         - mpm_simple
  82       the list may be incomplete
  83       maybe some of the modules will not be included in 2.4
  84     - mod_suexec: very little documentation
  85
  86 - mod_substitute and reverse proxies: Add example using mod_filter
  87   (see: http://marc.info/?l=apache-httpd-users&m=128830729603423&w=2)
  88
  89 - MPM documentation
  90      - explain what the following command line options do
  91        (perhaps in the developer/debugging docs):
  92         -D DEBUG
  93         -D ONE_PROCESS
  94               one-process-mode == no threads, i.e. only one
  95               process handling the requests in a single loop?
  96
  97 - Identify which documents are grossly out of date, and fix.
  98      - platform/ebcdic.xml - needs major rework for 2.0
  99      - SSL docs need serious update and enhancement
 100         - compat docs are wrong
 101         - no basic how to setup ssl doc
 102         mads said he was working on this, but...
 103
 104 - API documentation
 105     - Ben Laurie has written some hooks documentation
 106     - authn provider API documentation could be useful
 107
 108 - How does <Proxy> fit into sections.html?
 109
 110 - Missing documentation for the support program checkgid
 111
 112 - New user docs: Directory Handling (mod_dir/mod_autoindex/etc)
 113   (draft available in wiki)
 114
 115 - Enhancements to the DTD/XSL:
 116   - New index: directives by context, including listing which directives
 117     are available for each AllowOverride setting.
 118   - New index: backout modules by type (aaa, mappers, loggers etc.)
 119     probably by introducing a <category> element in modulesynopsis
 120   - Use a tag like <var> in place of <em> for things like the
 121     <syntax> listing.
 122     - in progress
 123   - add letter links to glossary and quickreference,
 124     perhaps also a term overview (sidebar)
 125   - remove <pre> elements. Use <br /> and <indent> elements to get
 126     a similar effect.
 127
 128 - Provide example solutions for the mapping of encodings, especially
 129   for .gz etc. (also in regard to our default configuration)
 130
 131 - How-To style documents for more of the daily tasks
 132     - Logging, log rotation, and log reporting
 133     - Secure mod_dav configuration
 134
 135 - Writing modules - Can we provide a basic intro to writing modules,
 136   perhaps based around mod_example, or one of the other simple example
 137   modules?
 138
 139 - http://httpd.apache.org/docs/trunk/developer/ is a graveyard, and a
 140   profound embarrassment.
 141     - Purge all the dead links
 142     - Introductory module authoring doc
 143     - Verify links to external resources at least every year
 144
 145 - Update the list of translations at
 146   http://httpd.apache.org/docs-project/translations.html  Some of those
 147   are accurate, and others are way outdated.
 148
 149 - I'd like to expand the discussion of conditional logging, and add a
 150   few more useful exmaples.
 151   That would be a good place to document logging of cache hit/miss:
 152   https://issues.apache.org/bugzilla/show_bug.cgi?id=48241#c2
 153
 154 - Is it worth having a doc that discusses recommended (what does this
 155   mean?) third-party modules like mod_security, mod_php, and so on - the
 156   things that we all assume everyone uses, but some folks might not know
 157   about.
 158
 159 - Clarify which directives only affect requests when they're handled
 160   by the default handler.  (e.g. ForceType, TraceEnable, etc.)
 161
 162 - Order directives alphabetically. Some modules, particularly in
 163   translations, have directives in random order, rather than
 164   alphabetically.
 165
 166 - Run review_translations.pl on each of the files in the mod directory,
 167   and determine which directives are missing from the translation docs.
 168   Add them. This makes them show up in the directives listing for that
 169   language, and also encourages translators to provide translations for
 170   those directives.
 171
 172 LaTeX Todo list
 173 ==================
 174
 175 - Dozens of other little problems with presentation, cross-referencing,
 176   etc.
 177
 178 - Cleanup xsl to make it more readable.  Almost everything
 179   that is currently in latex.xsl should probably be moved to common.xsl.
 180   There may be a license problem with the atbeginend.sty file, since
 181   latex style files rarely have explict licenses.  At worst, we can
 182   drop this and manually adjust the relevant spacing.
 183
 184 - Reduce the size of the pdf (both bytes and pages) in any way possible.
 185
 186 - Translations.
 187