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