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 - Remove mentions of the 1.2 and 1.3 versions of the server.
  24
  25 - Update the http://httpd.apache.org/docs-project/docsformat.html
  26   document to be useful. In particular:
  27     - Document the various macros that can be used in documents.
  28     - Document the translation process.
  29     - Generally update it to make it reflect the current reality of how
  30       we work.
  31     -  Improving the documentation of the documentations' build system
  32        itself (requirements, procedures)
  33
  34 - Update this document. Determine which of these issues are in fact
  35   still open, and which have already been dealt with.
  36
  37 - Identify which documents are grossly out of date, and fix.
  38
  39 - The FAQ never amounted to much. Review the current FAQ, which is
  40   1.3-era, and bring it into this century.
  41
  42 - Security docs are unhelpful, and assume that the reader knows nothing.
  43   Need something a little more advanced, which either discusses
  44   application-level security, or links to something that does. I'm not
  45   even sure what to say needs done. Can we get someone to elaborate on
  46   what, exactly, needs written? Ivan Ristic has said maybe he would be
  47   willing to contribute.
  48   - More content and better organisation
  49   - mod_dav resources are owned by the httpd. Perhaps write up the
  50     two-httpd dav setup covered in Rich Bowen's DAV Apachecon
  51     presentation.
  52
  53 - Performance doc is way too low-level. Several people have said that
  54   they might help out here, but it's a significant undertaking, and more
  55   than a little daunting.
  56
  57 - Windows platform docs are in desperate need of rewrites/updates for 2.x.
  58     - Bill Rowe and Bill Stoddard are good contacts for tech questions.
  59     - "using apache" has been done, "compiling apache" is still open
  60     - hints on uninstalling apache (exit monitor, close directories,
  61       registry entries etc) (PR 10154)
  62     - FAQ: UTF-8 config and URL encoding for non-ascii characters.
  63
  64 - New Auth system
  65     - Much clean-up and enhancement of aaa howto
  66     - Independent note on how to upgrade to new auth system
  67     - Discussion of DBD auth, and, in particular, examples of how to set
  68       up auth using each of the supported databases.
  69
  70 - modules docs
  71     - the follwing modules added since 2.2 lack documentation
  72         - mod_dialup
  73         - mod_lua
  74         - mod_ratelimit
  75         - mod_serf
  76         - mod_watchdog
  77         - mod_heartbeat
  78         - mod_heartmonitor
  79         - mod_lbmethod_bybusyness
  80         - mod_lbmethod_byrequests
  81         - mod_lbmethod_bytraffic
  82         - mod_lbmethod_heartbeat
  83         - mod_socache_dbm
  84         - mod_socache_memcache
  85         - mod_socache_shmcb
  86         - mpm_simple
  87       the list may be incomplete
  88       maybe some of the modules will not be included in 2.4
  89     - mod_suexec: very little documentation
  90     - mod_rewrite: explain, when which variables are actually available
  91       (PR 16402)
  92
  93 - MPM documentation
  94      - explain what the following command line options do
  95        (perhaps in the developer/debugging docs):
  96         -D DEBUG
  97         -D ONE_PROCESS
  98               one-process-mode == no threads, i.e. only one
  99               process handling the requests in a single loop?
 100
 101 - Individual docs will need some cleanup.
 102      - misc/rewriteguide.html - needs cleaning in 1.3 and 2.0
 103      - platform/ebcdic.xml - needs major rework for 2.0
 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 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 - Rewriting the 'custom error' doc, which is ancient and doesn't flow
 158   very well.
 159
 160 - I'd like to expand the discussion of conditional logging, and add a
 161   few more useful exmaples.
 162
 163 - The mod_usertrack docs should describe what the module does, now,
 164   rather than spending so much time comparing it to what a long-gone
 165   module, which our readers never used, used to do. Examples would be
 166   helpful. Additionally, a significant part of the doc consists of a
 167   quoted email message. This seems somewhat unprofessional.
 168
 169 - Document mod_lua based on the various docs at
 170   https://svn.apache.org/repos/asf/httpd/httpd/trunk/modules/lua/docs/
 171
 172 LaTeX Todo list
 173 ==================
 174
 175 - Dozens of other little problems with presentation, cross-referencing,
 176   etc.
 177
 178 - Cleanup xsl to make it more readable.  Almost everything
 179   that is currently in latex.xsl should probably be moved to common.xsl.
 180   There may be a license problem with the atbeginend.sty file, since
 181   latex style files rarely have explict licenses.  At worst, we can
 182   drop this and manually adjust the relevant spacing.
 183
 184 - Reduce the size of the pdf (both bytes and pages) in any way possible.
 185
 186 - Translations.
 187