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