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      - dso.xml - Reads as though this is a nifty new thing we just came
 105        up with recently.
 106
 107 - API documentation
 108     - Ben Laurie has written some hooks documentation
 109     - authn provider API documentation could be useful
 110
 111 - SSL docs need serious update and enhancement
 112     - compat docs are wrong
 113     - no basic how to setup ssl doc
 114     mads said he was working on this, but...
 115
 116 - How does <Proxy> fit into sections.html?
 117
 118 - Missing documentation for the support program checkgid
 119
 120 - New user docs: Directory Handling (mod_dir/mod_autoindex/etc)
 121   (draft available in wiki)
 122
 123 - Enhancements to the DTD/XSL:
 124   - New index: directives by context, including listing which directives
 125     are available for each AllowOverride setting.
 126   - New index: backout modules by type (aaa, mappers, loggers etc.)
 127     probably by introducing a <category> element in modulesynopsis
 128   - Use a tag like <var> in place of <em> for things like the
 129     <syntax> listing.
 130     - in progress
 131   - add letter links to glossary and quickreference,
 132     perhaps also a term overview (sidebar)
 133   - remove <pre> elements. Use <br /> and <indent> elements to get
 134     a similar effect.
 135
 136 - Provide example solutions for the mapping of encodings, especially
 137   for .gz etc. (also in regard to our default configuration)
 138
 139 - How-To style documents for more of the daily tasks
 140     - Logging and log reporting
 141     - ?
 142
 143 - Writing modules - Can we provide a basic intro to writing modules,
 144   perhaps based around mod_example, or one of the other simple example
 145   modules?
 146
 147 - http://httpd.apache.org/docs/trunk/developer/ is a graveyard, and a
 148   profound embarrassment.
 149     - Purge all the dead links
 150     - API docs are generated via 'make dox'. Find somewhere that we can
 151       do this on a schedule, and link to that from the documentation.
 152     - Introductory module authoring doc
 153     - Verify links to external resources at least every year
 154
 155 - Update the list of translations at
 156   http://httpd.apache.org/docs-project/translations.html  Some of those
 157   are accurate, and others are way outdated.
 158
 159 - Rewriting the 'custom error' doc, which is ancient and doesn't flow
 160   very well.
 161
 162 - I'd like to expand the discussion of conditional logging, and add a
 163   few more useful exmaples.
 164
 165 - The mod_usertrack docs should describe what the module does, now,
 166   rather than spending so much time comparing it to what a long-gone
 167   module, which our readers never used, used to do. Examples would be
 168   helpful. Additionally, a significant part of the doc consists of a
 169   quoted email message. This seems somewhat unprofessional.
 170
 171 - Document mod_lua based on the various docs at
 172   https://svn.apache.org/repos/asf/httpd/httpd/trunk/modules/lua/docs/
 173
 174 LaTeX Todo list
 175 ==================
 176
 177 - Dozens of other little problems with presentation, cross-referencing,
 178   etc.
 179
 180 - Cleanup xsl to make it more readable.  Almost everything
 181   that is currently in latex.xsl should probably be moved to common.xsl.
 182   There may be a license problem with the atbeginend.sty file, since
 183   latex style files rarely have explict licenses.  At worst, we can
 184   drop this and manually adjust the relevant spacing.
 185
 186 - Reduce the size of the pdf (both bytes and pages) in any way possible.
 187
 188 - Translations.
 189