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 - Identify which documents are grossly out of date, and fix.
  32
  33 - The FAQ never amounted to much. Review the current FAQ, which is
  34   1.3-era, and bring it into this century. (RBowen - I've copied the FAQ
  35   into the wiki at http://wiki.apache.org/httpd/FAQ and am editing it
  36   there. Consensus seems to be that this should be its new home.)
  37
  38 - Security docs are unhelpful, and assume that the reader knows nothing.
  39   Need something a little more advanced, which either discusses
  40   application-level security, or links to something that does. I'm not
  41   even sure what to say needs done. Can we get someone to elaborate on
  42   what, exactly, needs written? Ivan Ristic has said maybe he would be
  43   willing to contribute.
  44   - More content and better organisation
  45   - mod_dav resources are owned by the httpd. Perhaps write up the
  46     two-httpd dav setup covered in Rich Bowen's DAV Apachecon
  47     presentation.
  48
  49 - Performance doc is way too low-level. Several people have said that
  50   they might help out here, but it's a significant undertaking, and more
  51   than a little daunting.
  52
  53 - Windows platform docs are in desperate need of rewrites/updates for 2.x.
  54     - Bill Rowe is a good contact for tech questions.
  55     - "using apache" has been done, "compiling apache" is still open
  56     - hints on uninstalling apache (exit monitor, close directories,
  57       registry entries etc) (PR 10154)
  58     - FAQ: UTF-8 config and URL encoding for non-ascii characters.
  59
  60 - New Auth system
  61     - Much clean-up and enhancement of aaa howto
  62     - Independent note on how to upgrade to new auth system
  63     - Discussion of DBD auth, and, in particular, examples of how to set
  64       up auth using each of the supported databases.
  65
  66 - Expression syntax for <If> and Require expr
  67     - Need complete documentation for the expression syntax.
  68       (Is there any design doc for this?  Or do we need to
  69       read server/util_expr.c?)
  70     - This should wait until the future of ap_expr is decided.
  71       See http://mail-archives.apache.org/mod_mbox/httpd-dev/201010.mbox/%3C201010231336.33829.sf@sfritsch.de%3E
  72
  73 - modules docs
  74     - the follwing modules added since 2.2 lack documentation
  75         - mod_serf
  76         - mod_watchdog
  77         - mod_heartbeat
  78         - mod_heartmonitor
  79         - mod_lbmethod_bybusyness
  80         - mod_lbmethod_byrequests
  81         - mod_lbmethod_bytraffic
  82         - mod_lbmethod_heartbeat
  83         - mod_socache_dbm
  84         - mod_socache_memcache
  85         - mod_socache_shmcb
  86         - mpm_simple
  87       the list may be incomplete
  88       maybe some of the modules will not be included in 2.4
  89     - The following modules have new docs added since 2.2, but are
  90       grossly lacking in details and examples.
  91         - mod_dialup
  92     - mod_suexec: very little documentation
  93     - mod_rewrite: explain, when which variables are actually available
  94       (PR 16402)
  95
  96 - mod_substitute and reverse proxies: Add example using mod_filter
  97   (see: http://marc.info/?l=apache-httpd-users&m=128830729603423&w=2)
  98
  99 - MPM documentation
 100      - explain what the following command line options do
 101        (perhaps in the developer/debugging docs):
 102         -D DEBUG
 103         -D ONE_PROCESS
 104               one-process-mode == no threads, i.e. only one
 105               process handling the requests in a single loop?
 106
 107 - Individual docs will need some cleanup.
 108      - platform/ebcdic.xml - needs major rework for 2.0
 109      - dso.xml - Reads as though this is a nifty new thing we just came
 110        up with recently.
 111
 112 - API documentation
 113     - Ben Laurie has written some hooks documentation
 114     - authn provider API documentation could be useful
 115
 116 - SSL docs need serious update and enhancement
 117     - compat docs are wrong
 118     - no basic how to setup ssl doc
 119     mads said he was working on this, but...
 120
 121 - How does <Proxy> fit into sections.html?
 122
 123 - Missing documentation for the support program checkgid
 124
 125 - New user docs: Directory Handling (mod_dir/mod_autoindex/etc)
 126   (draft available in wiki)
 127
 128 - Enhancements to the DTD/XSL:
 129   - New index: directives by context, including listing which directives
 130     are available for each AllowOverride setting.
 131   - New index: backout modules by type (aaa, mappers, loggers etc.)
 132     probably by introducing a <category> element in modulesynopsis
 133   - Use a tag like <var> in place of <em> for things like the
 134     <syntax> listing.
 135     - in progress
 136   - add letter links to glossary and quickreference,
 137     perhaps also a term overview (sidebar)
 138   - remove <pre> elements. Use <br /> and <indent> elements to get
 139     a similar effect.
 140
 141 - Provide example solutions for the mapping of encodings, especially
 142   for .gz etc. (also in regard to our default configuration)
 143
 144 - How-To style documents for more of the daily tasks
 145     - Logging, log rotation, and log reporting
 146     - Secure mod_dav configuration
 147
 148 - Writing modules - Can we provide a basic intro to writing modules,
 149   perhaps based around mod_example, or one of the other simple example
 150   modules?
 151
 152 - http://httpd.apache.org/docs/trunk/developer/ is a graveyard, and a
 153   profound embarrassment.
 154     - Purge all the dead links
 155     - API docs are generated via 'make dox'. Find somewhere that we can
 156       do this on a schedule, and link to that from the documentation.
 157     - Introductory module authoring doc
 158     - Verify links to external resources at least every year
 159
 160 - Update the list of translations at
 161   http://httpd.apache.org/docs-project/translations.html  Some of those
 162   are accurate, and others are way outdated.
 163
 164 - I'd like to expand the discussion of conditional logging, and add a
 165   few more useful exmaples.
 166   That would be a good place to document logging of cache hit/miss:
 167   https://issues.apache.org/bugzilla/show_bug.cgi?id=48241#c2
 168
 169 - Is it worth having a doc that discusses recommended (what does this
 170   mean?) third-party modules like mod_security, mod_php, and so on - the
 171   things that we all assume everyone uses, but some folks might not know
 172   about.
 173
 174 - Clarify which directives only affect requests when they're handled
 175   by the default handler.  (e.g. ForceType, TraceEnable, etc.)
 176
 177 LaTeX Todo list
 178 ==================
 179
 180 - Dozens of other little problems with presentation, cross-referencing,
 181   etc.
 182
 183 - Cleanup xsl to make it more readable.  Almost everything
 184   that is currently in latex.xsl should probably be moved to common.xsl.
 185   There may be a license problem with the atbeginend.sty file, since
 186   latex style files rarely have explict licenses.  At worst, we can
 187   drop this and manually adjust the relevant spacing.
 188
 189 - Reduce the size of the pdf (both bytes and pages) in any way possible.
 190
 191 - Translations.
 192