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