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