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