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